batdetect2/docs/source/development/index.md
2026-03-28 18:51:40 +00:00

819 B

Development and contribution

Thanks for your interest in improving batdetect2.

Ways to contribute

  • Report bugs and request features on GitHub Issues
  • Improve docs by opening pull requests with clearer examples, fixes, or missing workflows
  • Contribute code for models, data handling, evaluation, or CLI workflows

Basic contribution workflow

  1. Open an issue (or comment on an existing one) so work is visible.
  2. Create a branch for your change.
  3. Run checks locally before opening a PR:
just check
just docs
  1. Open a pull request with a clear summary of what changed and why.

Development environment

Use uv for dependency and environment management.

uv sync

For more setup details, see {doc}../getting_started.