docs: Update CONTRIBUTING.md for clarity and formatting improvements#2060
docs: Update CONTRIBUTING.md for clarity and formatting improvements#2060
Conversation
|
The preview can be found in https://github.com/roboflow/supervision/blob/update/CONTRIBUTING/CONTRIBUTING.md |
There was a problem hiding this comment.
Pull request overview
This pull request enhances the CONTRIBUTING.md file with improved clarity, formatting, and detailed setup instructions. The changes aim to make the contribution process more accessible to new contributors by providing explicit platform-specific commands and better organized documentation.
Key changes:
- Updated dependency installation commands from
uv pip installtouv syncfor consistency with modern uv practices - Added platform-specific virtual environment setup instructions for Windows and Linux/macOS
- Enhanced formatting of conventional commit types and pre-commit instructions with better code blocks and structure
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #2060 +/- ##
=======================================
Coverage 52% 52%
=======================================
Files 61 61
Lines 7077 7077
=======================================
Hits 3657 3657
Misses 3420 3420 🚀 New features to boost your workflow:
|
|
@Borda looks like CLA did not triggered. Curious why... |
That is an external application, so I may need to get access to it to check why... but as it is external, it could be an outage or bug... |
This pull request updates and improves the
CONTRIBUTING.mddocumentation to provide clearer, more detailed, and more user-friendly contribution guidelines. The changes focus on clarifying setup instructions, improving formatting and readability, updating tool usage instructions, and ensuring consistency across the documentation.Improvements to setup and development workflow:
uv. [1] [2]pre-commit, including how to run checks and optionally install it as a git hook for automated checks on commit.uv.pytestand how to check test coverage.Formatting and clarity enhancements:
Other documentation updates: