Skip to content

docs: Update CONTRIBUTING.md for clarity and formatting improvements#2060

Merged
Borda merged 6 commits intodevelopfrom
update/CONTRIBUTING
Jan 12, 2026
Merged

docs: Update CONTRIBUTING.md for clarity and formatting improvements#2060
Borda merged 6 commits intodevelopfrom
update/CONTRIBUTING

Conversation

@Borda
Copy link
Member

@Borda Borda commented Jan 7, 2026

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

  • Expanded and clarified the development environment setup steps, including explicit instructions for setting up the upstream remote, creating and activating virtual environments on different platforms, and installing dependencies with uv. [1] [2]
  • Updated the installation and usage instructions for pre-commit, including how to run checks and optionally install it as a git hook for automated checks on commit.
  • Improved instructions for running documentation locally, including separate steps for installing documentation dependencies and starting the server with uv.
  • Clarified and updated testing instructions, including how to run tests with pytest and how to check test coverage.

Formatting and clarity enhancements:

  • Improved formatting of conventional commit message guidelines by using code blocks and bullet points, and clarified commit type descriptions.
  • Reworded and clarified requirements for Google Colab sharing and notebook contribution guidelines, emphasizing accessibility and self-containment. [1] [2]

Other documentation updates:

  • Updated the note about type checking to clarify the current status and future plans for mypy integration.

Copilot AI review requested due to automatic review settings January 7, 2026 21:07
@Borda Borda requested a review from SkalskiP as a code owner January 7, 2026 21:07
@Borda
Copy link
Member Author

Borda commented Jan 7, 2026

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.

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 install to uv sync for 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.

Borda and others added 3 commits January 7, 2026 22:14
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Borda Borda enabled auto-merge (squash) January 9, 2026 08:14
@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 (5695b7f) to head (ae008be).
⚠️ Report is 1 commits behind head on develop.

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@SkalskiP
Copy link
Collaborator

@Borda looks like CLA did not triggered. Curious why...

@Borda
Copy link
Member Author

Borda commented Jan 12, 2026

@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...

@Borda Borda disabled auto-merge January 12, 2026 13:05
@Borda Borda merged commit bbc96e1 into develop Jan 12, 2026
25 checks passed
@Borda Borda deleted the update/CONTRIBUTING branch January 12, 2026 13:05
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