Contribution Guide
Development Workflow
Section titled “Development Workflow”Follow these steps to contribute a new feature or bug fix:
-
Fork the Repository Create a personal fork of the repository on GitHub.
-
Create a Feature Branch
Terminal window git checkout -b feature/my-new-feature -
Implement Your Changes Ensure your code follows the existing style and is well-documented.
-
Run Linters and Tests
Terminal window bun lint# bun test (when tests are added) -
Submit a Pull Request Push your branch to your fork and open a PR against the
mainbranch.
PR Guidelines
Section titled “PR Guidelines”- Atomic Commits: Keep your commits small and focused on a single change.
- Descriptive Titles: Use Conventional Commits for your PR titles.
- Documentation: If you’re adding a new feature, update the relevant documentation in the
docs/directory.
Adding Support for New Languages
Section titled “Adding Support for New Languages”To add support for a new programming language in the AST Chunker:
- Find the Tree-sitter WASM grammar for the language.
- Add it to
ai-code-review/lib/wasm/. - Register the language in
ai-code-review/lib/tree-sitter.ts. - Update the
TARGET_NODE_TYPESinai-code-review/lib/ast-chunker.tsif necessary.