Update CONTRIBUTING.md#1969
Conversation
Updated type checking to include hints and mypy/pyright; refreshed links to latest docs, LICENSE, and cookbook examples.
|
|
|
@leuwenhoek, mind check the CLA, pls :) |
There was a problem hiding this comment.
Pull request overview
This PR updates the CONTRIBUTING.md file to align with current project practices and fix outdated documentation. The main goal is to improve accuracy and usefulness for contributors by updating type checking guidance and refreshing links to point to stable documentation versions.
Key Changes:
- Updated type checking section to reflect the presence of type hints and encourage use of mypy/pyright
- Fixed documentation links to use
/latest/and/stable/URLs instead of/develop/branch-specific URLs - Corrected commit message format example by removing unnecessary escape characters
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## 📄 License | ||
|
|
||
| By contributing, you agree that your contributions will be licensed under an [MIT license](https://github.com/roboflow/supervision/blob/develop/LICENSE.md). | ||
| By contributing, you agree that your contributions will be licensed under an [MIT license](https://github.com/roboflow/supervision/blob/main/LICENSE). |
There was a problem hiding this comment.
The LICENSE link is incorrect. The actual file in the repository is named LICENSE.md, not LICENSE. This will result in a broken link (404 error). The link should be updated to https://github.com/roboflow/supervision/blob/main/LICENSE.md to match the actual file name.
| By contributing, you agree that your contributions will be licensed under an [MIT license](https://github.com/roboflow/supervision/blob/main/LICENSE). | |
| By contributing, you agree that your contributions will be licensed under an [MIT license](https://github.com/roboflow/supervision/blob/main/LICENSE.md). |
|
seems to be stale since its creation, as the author did not even approve the CLA 🐰 |
This pull request updates the
CONTRIBUTING.mdfile to improve clarity, accuracy, and guidance for contributors. The changes modernize references, clarify instructions, and encourage best practices for code contributions.Improvements to contribution guidelines and references:
mainbranch instead ofdevelop.mypyandpyright.Clarifications and formatting: