Pull Request Guidelines
We follow a strict feature-branch workflow. All changes must go through a Pull Request.
Branch Naming
Use descriptive, kebab-case branch names prefixed by type:
feature/add-gemini-support
fix/hallucination-in-monorepos
docs/update-iteration-guide
chore/update-dependencies
Workflow
- Fork the repository (external contributors) or create a branch (team members)
- Create your branch from
main:git checkout main git pull origin main git checkout -b feature/your-feature - Make changes — follow existing code patterns
- Commit — Husky will auto-format, lint, and test:
git add . git commit -m "feat: add support for Dart file extension" - Push your branch:
git push origin feature/your-feature - Open a Pull Request against
main
Commit Message Convention
Use Conventional Commits format:
<type>: <description>
[optional body]
Types:
feat— New featurefix— Bug fixdocs— Documentation onlychore— Maintenance (deps, config)refactor— Code change that neither fixes a bug nor adds a featuretest— Adding or updating tests
Examples:
feat: add Dart and Flutter file extension support
fix: prevent hallucination in multi-stack repos
docs: update iteration depth guide with real-world examples
chore: bump @ax-llm/ax to 1.2.0
PR Checklist
Before requesting review, ensure:
- [ ] Code compiles:
npm run build - [ ] Tests pass:
npm test - [ ] Linting passes:
npm run lint - [ ] Documentation updated (if applicable)
- [ ] Commit messages follow conventions
- [ ] Branch is rebased on latest
main
Review Process
- At least one approval is required
- All CI checks must pass
- Squash merge into
main - Delete the feature branch after merge