CONTRIBUTING.md

Contributing to CedarMapper

Development Setup

1. Clone the repository
2. Create a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install in development mode with all dependencies:

   pip install -e ".[dev]"

Code Standards

Formatting

Code must be formatted with Black:

black src/ tests/

Linting

Code is checked with Ruff:

ruff check src/ tests/
ruff check --fix src/ tests/  # Auto-fix

Type Checking

Run mypy for type checking:

mypy src/

Testing

Write tests in tests/ directory. Run with pytest:

pytest
pytest --cov  # With coverage
pytest -v     # Verbose

Before Committing

Run the full test suite:

black src/ tests/
ruff check --fix src/ tests/
mypy src/
pytest

Or use a pre-commit hook to automate this. The GitHub Actions workflow will also check these.

Pull Requests

1. Create a feature branch: git checkout -b feature/your-feature
2. Make your changes and write tests
3. Ensure all checks pass locally
4. Create a pull request with a clear description