Skip to content

Commit a096134

Browse files
docs: add badges, CONTRIBUTING.md, and CHANGELOG.md
- Add npm version, downloads, and codecov badges to README - Create CONTRIBUTING.md with standard OSS contribution guidelines - Create CHANGELOG.md documenting v1.0.0 features
1 parent f8feaad commit a096134

3 files changed

Lines changed: 194 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.0.0] - 2026-01-25
9+
10+
### Added
11+
12+
- **Core Features**
13+
- Agentic repository analysis using GitHub Copilot SDK
14+
- Generate 12+ interconnected markdown documentation files
15+
- Support for TypeScript, Python, Go, Rust, Java, and more languages
16+
- Schema validation with Zod and auto-retry on failures
17+
- Smart file prioritization and byte budget management
18+
19+
- **CLI Commands**
20+
- `bootcamp <url>` - Generate full bootcamp documentation
21+
- `bootcamp ask <url>` - Interactive Q&A mode without full generation
22+
- `bootcamp web` - Start local web demo server
23+
24+
- **CLI Options**
25+
- `--branch` - Analyze specific branch
26+
- `--focus` - Focus on onboarding, architecture, contributing, or all
27+
- `--audience` - Target new-hire, oss-contributor, or internal-dev
28+
- `--output` - Custom output directory
29+
- `--style` - Output styles: startup, enterprise, oss, devops
30+
- `--interactive` - Start Q&A mode after generation
31+
- `--compare` - Compare with git ref for version diffing
32+
- `--create-issues` - Create GitHub issues from starter tasks
33+
- `--render-diagrams` - Render Mermaid to SVG/PNG
34+
- `--fast` - Fast mode with inlined files (~15-30s)
35+
- `--json-only` - Only generate repo_facts.json
36+
- `--no-clone` - Use GitHub API instead of cloning
37+
38+
- **Generated Documentation**
39+
- BOOTCAMP.md - 1-page overview
40+
- ONBOARDING.md - Complete setup guide
41+
- ARCHITECTURE.md - System design with Mermaid diagrams
42+
- CODEMAP.md - Directory tour
43+
- FIRST_TASKS.md - 8-10 starter issues by difficulty
44+
- RUNBOOK.md - Operations guide
45+
- DEPENDENCIES.md - Dependency graph and analysis
46+
- SECURITY.md - Security patterns and findings
47+
- RADAR.md - Tech radar and onboarding risk score
48+
- IMPACT.md - Change impact analysis
49+
- diagrams.mmd - Mermaid diagram sources
50+
- repo_facts.json - Structured data for automation
51+
52+
- **Analysis Features**
53+
- Tech radar for identifying modern, stable, legacy, and risky technologies
54+
- Security analysis with scoring
55+
- Change impact analysis for key files
56+
- Dependency graph generation
57+
- Version comparison (DIFF.md)
58+
59+
- **Integrations**
60+
- GitHub issue creation from starter tasks
61+
- Web demo server with Express
62+
- Plugin system for custom analyzers
63+
- Template packs for output customization
64+
65+
- **Developer Experience**
66+
- 205 passing tests with Vitest
67+
- Full TypeScript support
68+
- Beautiful CLI output with progress indicators
69+
- Streaming responses during analysis
70+
71+
[1.0.0]: https://github.com/Arthur742Ramos/repo-bootcamp/releases/tag/v1.0.0

CONTRIBUTING.md

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Contributing to Repo Bootcamp
2+
3+
Thank you for your interest in contributing to Repo Bootcamp! This document provides guidelines and instructions for contributing.
4+
5+
## Code of Conduct
6+
7+
By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.
8+
9+
## How to Contribute
10+
11+
### Reporting Bugs
12+
13+
Before submitting a bug report:
14+
15+
1. Check the [existing issues](https://github.com/Arthur742Ramos/repo-bootcamp/issues) to avoid duplicates
16+
2. Use the latest version to see if the bug has been fixed
17+
18+
When submitting a bug report, include:
19+
20+
- A clear, descriptive title
21+
- Steps to reproduce the issue
22+
- Expected vs actual behavior
23+
- Your environment (Node.js version, OS, etc.)
24+
- Any relevant error messages or logs
25+
26+
### Suggesting Features
27+
28+
Feature suggestions are welcome! Please:
29+
30+
1. Check existing issues and discussions first
31+
2. Provide a clear use case for the feature
32+
3. Explain why it would benefit other users
33+
34+
### Pull Requests
35+
36+
1. **Fork the repository** and create your branch from `main`
37+
2. **Install dependencies**: `npm install`
38+
3. **Make your changes** following the code style guidelines
39+
4. **Add tests** for any new functionality
40+
5. **Run the test suite**: `npm test`
41+
6. **Ensure the build passes**: `npm run build`
42+
7. **Submit a pull request** with a clear description of your changes
43+
44+
## Development Setup
45+
46+
```bash
47+
# Clone your fork
48+
git clone https://github.com/YOUR_USERNAME/repo-bootcamp.git
49+
cd repo-bootcamp
50+
51+
# Install dependencies
52+
npm install
53+
54+
# Build the project
55+
npm run build
56+
57+
# Run tests
58+
npm test
59+
60+
# Run tests in watch mode
61+
npm run test:watch
62+
63+
# Run with coverage
64+
npm run test:coverage
65+
```
66+
67+
## Code Style Guidelines
68+
69+
- **TypeScript**: All code should be written in TypeScript
70+
- **Formatting**: Follow the existing code style in the project
71+
- **Types**: Prefer explicit types over `any`
72+
- **Comments**: Add comments for complex logic, but prefer self-documenting code
73+
- **Naming**: Use descriptive variable and function names
74+
75+
## Testing
76+
77+
- All new features should include tests
78+
- All bug fixes should include regression tests
79+
- Run `npm test` before submitting a PR
80+
- Aim to maintain or improve test coverage
81+
82+
## Commit Messages
83+
84+
Write clear, concise commit messages:
85+
86+
- Use the present tense ("Add feature" not "Added feature")
87+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
88+
- Limit the first line to 72 characters
89+
- Reference issues and PRs when relevant
90+
91+
Examples:
92+
- `Add support for custom output templates`
93+
- `Fix parsing error for repos with spaces in names`
94+
- `Update documentation for --fast flag`
95+
96+
## Project Structure
97+
98+
```
99+
repo-bootcamp/
100+
├── src/ # Source code
101+
│ ├── index.ts # CLI entry point
102+
│ ├── agent.ts # Copilot SDK agent logic
103+
│ ├── ingest.ts # Repository scanning
104+
│ ├── generator.ts # Documentation generation
105+
│ └── ... # Other modules
106+
├── tests/ # Test files
107+
├── examples/ # Example outputs
108+
└── dist/ # Compiled output
109+
```
110+
111+
## Questions?
112+
113+
If you have questions, feel free to:
114+
115+
- Open a [discussion](https://github.com/Arthur742Ramos/repo-bootcamp/discussions)
116+
- Open an issue for clarification
117+
118+
## License
119+
120+
By contributing, you agree that your contributions will be licensed under the MIT License.

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,12 @@
1414

1515
[![Built with Copilot SDK](https://img.shields.io/badge/Built%20with-GitHub%20Copilot%20SDK-8957e5?logo=github&logoColor=white)](https://github.com/github/copilot-sdk)
1616
[![CI](https://github.com/Arthur742Ramos/repo-bootcamp/actions/workflows/ci.yml/badge.svg)](https://github.com/Arthur742Ramos/repo-bootcamp/actions/workflows/ci.yml)
17+
[![npm version](https://img.shields.io/npm/v/repo-bootcamp)](https://www.npmjs.com/package/repo-bootcamp)
18+
[![npm downloads](https://img.shields.io/npm/dm/repo-bootcamp)](https://www.npmjs.com/package/repo-bootcamp)
19+
[![codecov](https://codecov.io/gh/Arthur742Ramos/repo-bootcamp/branch/main/graph/badge.svg)](https://codecov.io/gh/Arthur742Ramos/repo-bootcamp)
1720
[![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org/)
1821
[![TypeScript](https://img.shields.io/badge/TypeScript-5.6-blue)](https://www.typescriptlang.org/)
1922
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
20-
[![Tests](https://img.shields.io/badge/tests-205%20passing-brightgreen)](.)
2123

2224
[Features](#features)[Quick Start](#quick-start)[How It Uses Copilot SDK](#how-it-uses-the-github-copilot-sdk)[Examples](#example-output)
2325

0 commit comments

Comments
 (0)