Skip to content

Contribution Guide

Follow these steps to contribute a new feature or bug fix:

  1. Fork the Repository Create a personal fork of the repository on GitHub.

  2. Create a Feature Branch

    Terminal window
    git checkout -b feature/my-new-feature
  3. Implement Your Changes Ensure your code follows the existing style and is well-documented.

  4. Run Linters and Tests

    Terminal window
    bun lint
    # bun test (when tests are added)
  5. Submit a Pull Request Push your branch to your fork and open a PR against the main branch.

  • 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.

To add support for a new programming language in the AST Chunker:

  1. Find the Tree-sitter WASM grammar for the language.
  2. Add it to ai-code-review/lib/wasm/.
  3. Register the language in ai-code-review/lib/tree-sitter.ts.
  4. Update the TARGET_NODE_TYPES in ai-code-review/lib/ast-chunker.ts if necessary.