Skip to content

Contributing

Contributions are welcome. Please read these guidelines before opening a pull request.


Getting Started

  1. Fork the repository and create a branch from main.
  2. Follow the Development Setup guide.
  3. Make your changes, adding or updating tests where applicable.
  4. Ensure all CI checks pass.
  5. Open a pull request with a clear description.

Code Style

Python 3.11+. Formatted with black, linted with ruff:

black annotation-backend/
ruff check annotation-backend/

React + Vite. ESLint is configured in package.json:

cd annotation_ui
npm run lint

Commit Messages

Use the imperative mood, short and descriptive:

Add CSV import preview endpoint
Fix thread colour assignment for >12 threads
Update Alembic migration for adjacency pairs

Reporting Issues


Licence

By contributing you agree that your contributions will be licensed under the MIT Licence.