Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (87 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

116 lines (87 loc) · 3.79 KB

Contributing to Code Graph RAG

Thank you for your interest in contributing to Code Graph RAG! We welcome contributions from the community.

Getting Started

  1. Browse Issues: Check out our GitHub Issues to find tasks that need work
  2. Pick an Issue: Choose an issue that interests you and matches your skill level
  3. Comment on the Issue: Let us know you're working on it to avoid duplicate effort
  4. Fork the Repository: Create your own fork to work on
  5. Create a Branch: Use a descriptive branch name like feat/add-feature or fix/bug-description

Development Process

  1. Set up Development Environment:

    git clone https://github.com/YOUR-USERNAME/code-graph-rag.git
cd code-graph-rag
uv sync --extra treesitter-full --extra test --extra dev

  2. Make Your Changes:

    • Follow the existing code style and patterns
    • Add tests for new functionality
    • Update documentation if needed

  3. Test Your Changes:

    • Run the existing tests to ensure nothing is broken
    • Test your new functionality thoroughly

  4. Submit a Pull Request:

    • Push your branch to your fork
    • Create a pull request against the main repository
    • Reference the issue number in your PR description
    • Provide a clear description of what you've changed and why

Pull Request Guidelines

  • Keep PRs focused on a single issue or feature
  • Write clear, descriptive commit messages
  • Include tests for new functionality
  • Update documentation when necessary
  • Be responsive to feedback during code review

Technical Requirements

Agentic Framework

  • PydanticAI Only: This project uses PydanticAI as the official agentic framework. Do not introduce other frameworks like LangChain, CrewAI, or AutoGen.

Code Standards

  • Heavy Pydantic Usage: Use Pydantic models extensively for data validation, serialization, and configuration
  • Package Management: Use uv for all dependency management and virtual environments
  • Code Quality: Use ruff for linting and formatting - run ruff check and ruff format before submitting
  • Type Safety: Use type hints everywhere and run mypy for type checking

Development Tools

  • uv: Package manager and dependency resolver
  • ruff: Code linting and formatting (replaces flake8, black, isort)
  • mypy: Static type checking
  • pytest: Testing framework

Pre-commit Hooks

This project uses pre-commit to automatically run checks before each commit, ensuring code quality and consistency.

To get started, first make sure you have the development dependencies installed:

uv sync --extra treesitter-full --extra test --extra dev

Then, install the git hooks:

pre-commit install
pre-commit autoupdate --repo https://github.com/pre-commit/pre-commit-hooks

Now, pre-commit will run automatically on git commit.

Code Style

  • Follow Python PEP 8 guidelines
  • Use type hints for all function signatures and class attributes
  • Write clear, self-documenting code
  • Add docstrings for public functions and classes
  • Use Pydantic models for data structures and validation

Questions?

If you have questions about contributing, feel free to:

  • Open a discussion on GitHub
  • Comment on the relevant issue
  • Reach out to the maintainers

We appreciate your contributions!

If you have questions about contributing, feel free to:

  • Open a discussion on GitHub
  • Comment on the relevant issue
  • Reach out to the maintainers

We appreciate your contributions!

Makefile Commands

This project uses a Makefile for streamlined development workflow:

# Set up complete development environment (recommended for new contributors)
make dev

# Run all tests
make test

# Clean up build artifacts and cache
make clean

# View all available commands
make help