Skip to content

Update CONTRIBUTING.md - #1969

Closed
leuwenhoek wants to merge 3 commits into
roboflow:developfrom
leuwenhoek:patch-1
Closed

Update CONTRIBUTING.md#1969
leuwenhoek wants to merge 3 commits into
roboflow:developfrom
leuwenhoek:patch-1

Conversation

@leuwenhoek

@leuwenhoek leuwenhoek commented Oct 2, 2025

Copy link
Copy Markdown

This pull request updates the CONTRIBUTING.md file 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:

  • Updated the example notebook template link to point to the latest version and clarified the notebook submission process. Also fixed the path to the MIT license to point to the main branch instead of develop.
  • Added a section specifying the use of type hints and recommending static type checking tools like mypy and pyright.
  • Added a new section header for "Contribution Guidelines" to improve document structure.

Clarifications and formatting:

  • Clarified the format for conventional commit messages by removing unnecessary escaping.
  • Added a directive to disable code execution in the bash code block for cloning the repository, improving safety for readers.

Updated type checking to include hints and mypy/pyright; refreshed links to latest docs, LICENSE, and cookbook examples.
@leuwenhoek
leuwenhoek requested a review from SkalskiP as a code owner October 2, 2025 09:49
@CLAassistant

CLAassistant commented Oct 2, 2025

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ Borda
❌ leuwenhoek
You have signed the CLA already but the status is still pending? Let us recheck it.

@Borda

Borda commented Jan 5, 2026

Copy link
Copy Markdown
Member

@leuwenhoek, mind check the CLA, pls :)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread CONTRIBUTING.md
## 📄 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).

Copilot AI Jan 5, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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).

Copilot uses AI. Check for mistakes.
@Borda
Borda marked this pull request as draft January 7, 2026 08:59
@Borda

Borda commented Feb 2, 2026

Copy link
Copy Markdown
Member

seems to be stale since its creation, as the author did not even approve the CLA 🐰
@leuwenhoek, thank you for your hel,p and feel free to send some other suggestions for improvement 🦩

@Borda Borda closed this Feb 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants