From 42d6a0940ca0290c50a43102f5bcc2bfcde6e39e Mon Sep 17 00:00:00 2001 From: mbsantiago Date: Sat, 28 Mar 2026 18:51:40 +0000 Subject: [PATCH] Add dev docs --- docs/source/development/index.md | 34 ++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/source/development/index.md diff --git a/docs/source/development/index.md b/docs/source/development/index.md new file mode 100644 index 0000000..390f3af --- /dev/null +++ b/docs/source/development/index.md @@ -0,0 +1,34 @@ +# Development and contribution + +Thanks for your interest in improving batdetect2. + +## Ways to contribute + +- Report bugs and request features on + [GitHub Issues](https://github.com/macaodha/batdetect2/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: + +```bash +just check +just docs +``` + +4. Open a pull request with a clear summary of what changed and why. + +## Development environment + +Use `uv` for dependency and environment management. + +```bash +uv sync +``` + +For more setup details, see {doc}`../getting_started`.