Contributing & Support¶
MegaDetector is open source and community-driven. This page explains where to file things, how to contribute changes, and how to get help.
Where does my issue belong?¶
The MegaDetector ecosystem spans a few repositories, so routing your report to the right place gets it answered faster:
| Your topic | Repository |
|---|---|
| MegaDetector models, the CLI, fine-tuning, these docs | microsoft/MegaDetector |
| The PyTorch-Wildlife framework, classifiers, demo notebooks | microsoft/Pytorch-Wildlife |
| Ecosystem-wide questions and discussion | microsoft/Biodiversity |
Reporting bugs and requesting features¶
Open an issue on microsoft/MegaDetector/issues. Helpful reports include the model variant and threshold you used, the command or code that triggered the problem, and a sample of the output. If you are reporting how MegaDetector performed on your data, good or bad, that feedback is genuinely useful for improving the models.
Submitting changes¶
- Fork the repository and create a branch for your change.
- Make your edits, for code, the Repository Architecture page explains the package layout; for docs, the Developer Guide covers building the site locally.
- Open a pull request describing the change and the motivation.
Documentation improvements are welcome and are often the easiest first contribution.
Reporting security issues¶
Please do not report security vulnerabilities through public GitHub issues. Follow the process in the repository's SECURITY.md, which routes reports to the Microsoft Security Response Center (MSRC).
Getting help¶
- Discord, join the PyTorch-Wildlife community
- GitHub Discussions, microsoft/Biodiversity/discussions
- Email, zhongqimiao@microsoft.com
Next steps¶
- Repository Architecture: orient yourself in the codebase
- Developer Guide: build and preview the docs
- FAQ: common questions before you file an issue