Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 2.03 KB

Contributing to CodeSage

We welcome contributions from the community! Please read this guide to learn how you can help.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

How to Contribute

  • Reporting Bugs: If you find a bug, please open an issue and provide as much detail as possible.
  • Suggesting Enhancements: If you have an idea for a new feature, open an issue to discuss it.
  • Pull Requests: We welcome pull requests. Please make sure your code follows the project's style guidelines and that all tests pass.

Development Setup

  1. Fork the repository.
  2. Clone your fork: git clone https://github.com/your-username/codesage.git
  3. Install dependencies: poetry install
  4. Set up pre-commit hooks: pre-commit install

Testing Requirements

All contributions must maintain our high testing standards:

  • Unit Tests: Minimum 95% coverage for new analyzer code
  • Performance Tests: Ensure parsing performance <500ms for 1000 LOC
  • Integration Tests: Test end-to-end parsing pipelines
  • Benchmark Tests: Use pytest-benchmark for performance validation

Run tests with:

# Run all tests with coverage
poetry run pytest --cov=codesage --cov-report=html

# Run performance benchmarks
poetry run pytest tests/performance/ --benchmark-only

# Run specific analyzer tests
poetry run pytest tests/unit/analyzers/ -v

Style Guide

We use black for code formatting and ruff for linting. Please make sure your code conforms to these standards by running pre-commit run --all-files before submitting a pull request.

Analyzer Development

When contributing to language analyzers, please follow the guidelines in docs/analyzer-development.md and ensure:

  • Proper AST model validation using Pydantic
  • Error recovery mechanisms for partial parsing
  • Comprehensive test fixtures with ground truth validation
  • Performance benchmarks for large codebases