Thank you for your interest in contributing to AutoDev! 🎉
We welcome contributions from developers of all experience levels.
- Code of Conduct
- Getting Started
- Development Setup
- Project Structure
- Making Changes
- Submitting a Pull Request
- Coding Standards
- Testing
- Reporting Issues
Please read and follow our Code of Conduct.
- Go ≥ 1.22
- Node.js ≥ 20
- pnpm ≥ 9
- Git
# Fork the repo on GitHub, then:
git clone https://github.com/YOUR_USERNAME/autodev.git
cd autodev# Install Node dependencies
pnpm install
# Download Go dependencies
cd packages/cli && go mod download
cd ../core && go mod download
cd ../scanner && go mod download
cd ../installer && go mod download
cd ../skills && go mod download
cd ../github && go mod download
cd ../..# Fast build for development
pnpm cli:build
# Or directly with Go
cd packages/cli
go build -o bin/autodev ./main.go
./bin/autodev --helppnpm website
# Opens http://localhost:3000autodev/
├── apps/
│ └── website/ # Next.js 15 marketing site
├── packages/
│ ├── cli/ # Main CLI entry point (Cobra + BubbleTea)
│ ├── core/ # Shared utilities (OS, config, logging)
│ ├── scanner/ # Repository detection engine
│ ├── installer/ # Runtime installer logic
│ ├── skills/ # skills.sh learning roadmap integration
│ └── github/ # GitHub API client
├── scripts/
│ ├── install.sh # Curl-pipe installer
│ └── build.sh
├── .github/workflows/ # GitHub Actions
└── go.work # Go workspace
# For features
git checkout -b feat/your-feature-name
# For bug fixes
git checkout -b fix/bug-description
# For documentation
git checkout -b docs/topicWe follow Conventional Commits:
feat: add kotlin detection to scanner
fix: correct go binary path on windows
docs: update installation instructions
test: add scanner unit tests for rust projects
chore: update dependencies
- Ensure all tests pass:
pnpm testandpnpm cli:test - Update documentation if needed
- Add/update tests for your changes
- Open a PR with a clear title and description
- Link any related issues with
Fixes #123
- Follow standard Go formatting (
gofmt) - Use
golangci-lintfor linting - Write tests for all exported functions
- Use meaningful variable names
- Add comments for exported types and functions
- Use TypeScript strictly (no
any) - Follow ESLint rules
- Use Prettier for formatting
cd packages/cli
go test ./... -v -race -coverpnpm --filter=website testWe require ≥ 90% coverage for Go packages.
- Bugs: Use the bug report template
- Features: Use the feature request template
- Security: See SECURITY.md — do NOT open a public issue
- Open a Discussion
Thank you for contributing! 🚀