Contributing

We welcome contributions to TCRsift!

Development Setup

1. Clone the repository:

   git clone https://github.com/pirl-unc/tcrsift.git
   cd tcrsift
   

2. Install in development mode:

   pip install -e ".[dev]"
   

3. Install pre-commit hooks:

   pre-commit install
   

Running Tests

pytest tests/ -v

With coverage:

pytest tests/ --cov=tcrsift --cov-report=term-missing

Code Style

We use:

• ruff for linting
• pylint for additional checks

Run linting:

./lint.sh

Documentation

Build documentation locally:

pip install mkdocs mkdocs-material mkdocstrings[python]
mkdocs serve

Then open http://localhost:8000.

Submitting Changes

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests and linting
5. Submit a pull request

See CONTRIBUTING.md for detailed guidelines.