Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (34 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

46 lines (34 loc) · 1.52 KB
Raw

Contributing to tdfextractor

Bug reports, fixes and new features are welcome. Use the issue tracker for bugs and questions, with a minimal example and the tdfextractor and Python versions. Report security problems privately as described in SECURITY.md.

Development setup

You need Python 3.12 or newer, uv and just.

git clone https://github.com/tacular-omics/tdfextractor.git
cd tdfextractor
just install

just --list shows the other recipes.

Running checks

CI runs these on every pull request. Run them before you push:

uv run ruff check src tests
uv run ruff format --check src tests
uv run ty check src
uv run pytest tests

Pull requests

  • Branch from main and keep each pull request to one change.
  • Add tests for new behaviour and fixed bugs.
  • Add a line under ## [Unreleased] in CHANGELOG.md for user-visible changes.
  • Do not change the version number; the maintainers set it when releasing.
  • CI must pass: lint, type check, tests on Python 3.12 to 3.14, and the wheel build.

CLAUDE.md and AI agents

CLAUDE.md is the maintained developer guide: commands, architecture, conventions and known gotchas. AGENTS.md points other coding agents to it. Read it before a larger change, and update it in the same pull request when your change makes part of it wrong. AI-assisted contributions are welcome; you are responsible for reviewing and testing what you submit.