Skip to content

Conversation

@Borda
Copy link
Member

@Borda Borda commented Jan 5, 2026

This pull request updates the documentation to ensure that the code of conduct and contributing guidelines reference the correct files in the .github directory. This helps centralize and standardize these important documents.

Documentation updates:

  • Updated the code of conduct include in docs/code_of_conduct.md to point to .github/CODE_OF_CONDUCT.md instead of CODE_OF_CONDUCT.md.
  • Updated the contributing guidelines include in docs/contributing.md to point to .github/CONTRIBUTING.md instead of CONTRIBUTING.md.

Copilot AI review requested due to automatic review settings January 5, 2026 21:00
@Borda Borda requested a review from SkalskiP as a code owner January 5, 2026 21:00
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@SkalskiP
Copy link
Collaborator

SkalskiP commented Jan 6, 2026

@Borda have you build docs locally to confirm mkdocs pulls those files from .github directory?

@Borda
Copy link
Member Author

Borda commented Jan 6, 2026

@Borda have you build docs locally to confirm mkdocs pulls those files from .github directory?

Shall be fixed by d404aa5 and a87b324

@SkalskiP
Copy link
Collaborator

SkalskiP commented Jan 6, 2026

One more thing. We currently link to https://github.com/roboflow/supervision/blob/main/CONTRIBUTING.md in our README.md. This link will work only until the next release to main. Since develop is our default branch, I suggest switching the path now to https://github.com/roboflow/supervision/blob/.github/CONTRIBUTING.md.

@Borda
Copy link
Member Author

Borda commented Jan 6, 2026

One more thing. We currently link to https://github.com/roboflow/supervision/blob/main/CONTRIBUTING.md in our README.md. This link will work only until the next release to main. Since develop is our default branch, I suggest switching the path now to https://github.com/roboflow/supervision/blob/.github/CONTRIBUTING.md.

Is there is reason why there is a hard-coded URL path?

@SkalskiP
Copy link
Collaborator

SkalskiP commented Jan 6, 2026

Is there is reason why there is a hard-coded URL path?

Is there any reason why we wouldn't like hard-coded URL here? You want to replace it with .github/CONTRIBUTING.md?

@Borda
Copy link
Member Author

Borda commented Jan 6, 2026

Is there any reason why we wouldn't like hard-coded URL here? You want to replace it with .github/CONTRIBUTING.md?

Well, no refactoring tool would work with it, and you need to keep in mind many edge-cases, also it does not allow any change since it would break between the dev and release branches...

@SkalskiP
Copy link
Collaborator

SkalskiP commented Jan 6, 2026

Cool let's update to .github/CONTRIBUTING.md.

@Borda Borda marked this pull request as draft January 7, 2026 15:37
@Borda
Copy link
Member Author

Borda commented Jan 12, 2026

waiting for #2061

@codecov
Copy link

codecov bot commented Jan 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52%. Comparing base (f1e0c9c) to head (0fcbd25).

Additional details and impacted files
@@           Coverage Diff           @@
##           develop   #2036   +/-   ##
=======================================
  Coverage       52%     52%           
=======================================
  Files           61      61           
  Lines         7076    7076           
=======================================
  Hits          3657    3657           
  Misses        3419    3419           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants