Update CONTRIBUTING.md with development setup and coding standards#1447
Merged
Update CONTRIBUTING.md with development setup and coding standards#1447
Conversation
Owner
liudger
commented
Apr 16, 2026
liudger
commented
- Add development setup instructions with uv
- Add coding standards section (Python 3.12+, Ruff, MyPy, Pylint)
- Add testing requirements (95%+ coverage, 100% patch coverage)
- Expand pull request process with clear steps
- Link to code of conduct
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1447 +/- ##
=======================================
Coverage 99.89% 99.89%
=======================================
Files 6 6
Lines 955 955
Branches 128 128
=======================================
Hits 954 954
Partials 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository contribution guidelines to document the expected local development workflow and contribution standards for the python-bsblan async Python client.
Changes:
- Add development setup instructions using
uv. - Document coding standards (Python 3.12+, Ruff/formatting, typing, linting) and how to run checks via
prek. - Add testing/coverage expectations and expand the pull request process steps, including a Code of Conduct link.
- Add development setup instructions with uv - Add coding standards section (Python 3.12+, Ruff, MyPy, Pylint) - Add testing requirements (95%+ coverage, 100% patch coverage) - Expand pull request process with clear steps - Link to code of conduct
The project uses ty for type checking (in pre-commit and CI), not MyPy. Updated CONTRIBUTING.md and copilot-instructions.md to match. Added site/ to .gitignore (mkdocs build output). # Conflicts: # .gitignore
The prettier pre-commit hook requires Node.js and npm packages. Updated CONTRIBUTING.md with prerequisites and pointed to make setup. Added npm ci to the Makefile setup target.
fail_under is set to 53 and CI doesn't enforce a coverage threshold. Reworded to describe 95%/100% as project targets tracked via Codecov.
liudger
force-pushed
the
docs/update-contributing
branch
from
eaf4b0c to
d957829
Compare
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.