docs: rewrite CONTRIBUTING.md - #660
Open
petercorke wants to merge 1 commit into
Open
Conversation
Fixes two real defects (dead empty link at the end, stale black/flake8 references -- actual tooling is ruff), adds the Conventional Commits PR-title note (commitlint.yml already enforces it), and points at good-first-issue/help-wanted labels instead of nothing. Same structure now shared across RTB/MVTB/bdsim.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #660 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 143 143
Lines 14050 14050
=====================================
Misses 14050 14050 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Rewrites
.github/CONTRIBUTING.md. Fixes two real defects in the previous version:See our typing [style guide]().)[tool.ruff]in pyproject.toml)Also adds:
commitlint.ymlalready enforces this, just wasn't documented)good first issue/help wantedlabels for newcomersmain)Same structure now shared with MVTB and bdsim's rewritten CONTRIBUTING.md (companion PRs), each filled in with that repo's actual tooling/test commands.
Test plan
commitlint.ymlexists and actually checks PR titlesgood first issue/help wantedlabels exist (created/aligned this session)