Revamp CONTRIBUTING.md by C-Achard · Pull Request #3241 · DeepLabCut/DeepLabCut
Rewrites and restructures CONTRIBUTING.md to improve onboarding and developer workflow. Adds clear sections for ways to contribute, development setup (fork/clone, installing dev dependencies via pyproject group, editable installs, and ./reinstall.sh), working on the code (verifying local import), code style and pre-commit setup, testing (pytest), and pull request guidelines. Encourages contributions from underrepresented groups, clarifies documentation and header procedures, and documents review process, support channels, and acknowledgements to contributors.
Replace the ad-hoc pip install line with an editable dev install (`pip install -e . --group dev`) to standardize the development environment. Clarify that only steering committee members may edit `NOTICE.yml`. Remove the standalone `black .` example and direct contributors to follow `CONTRIBUTING.md` for testing and pre-commit checks. Also add a `bash` code fence to the coverage example for consistency.
Fix CONTRIBUTING.md to state the script builds a wheel using setup.py instead of the 'build' tool. This corrects the documentation and clarifies the local install refresh workflow when packaged resources need to be updated.
Split a malformed blockquote line into two proper blockquote lines to fix Markdown rendering and remove an inline '>' that broke the quote. This is a formatting-only change to improve readability; no content was altered.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters