Make CONTRIBUTING.rst slightly more accurate - #429
Conversation
WalkthroughContribution documentation now uses ChangesContribution workflow
Estimated code review effort: 1 (Trivial) | ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Both of the changes were made solely on observation. Please feel free to ignore.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #429 +/- ##
========================================
Coverage 69.83% 69.83%
========================================
Files 6 6
Lines 1419 1419
========================================
Hits 991 991
Misses 428 428
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.rst`:
- Around line 99-116: Update the direct-testing instructions in CONTRIBUTING.rst
to invoke Python 3.9 explicitly, using python3.9 for the relevant commands or
clearly stating that python3 must resolve to Python 3.9; keep the existing test
workflow unchanged.
- Around line 69-71: Update the branch creation command in the contribution
instructions to explicitly base the new branch on develop, using origin/develop
or an equivalent explicit develop checkout rather than the current HEAD.
Preserve the existing branch-name placeholder and surrounding workflow.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: ece22094-3f6d-426d-a3ec-46793c1ca709
📒 Files selected for processing (1)
CONTRIBUTING.rst
| # now, create your own branch off the "develop": | ||
|
|
||
| $ git checkout -b your-bugfix-branch-name |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Make the branch base explicit.
git checkout -b creates the branch from the current HEAD, so this example does not guarantee that the branch is based on develop. Use origin/develop (or explicitly check out develop) in the command.
Proposed fix
- $ git checkout -b your-bugfix-branch-name
+ $ git checkout -b your-bugfix-branch-name origin/develop📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # now, create your own branch off the "develop": | |
| $ git checkout -b your-bugfix-branch-name | |
| # now, create your own branch off the "develop": | |
| $ git checkout -b your-bugfix-branch-name origin/develop |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.rst` around lines 69 - 71, Update the branch creation command in
the contribution instructions to explicitly base the new branch on develop,
using origin/develop or an equivalent explicit develop checkout rather than the
current HEAD. Preserve the existing branch-name placeholder and surrounding
workflow.
| You need to have Python 3.9 available in your system. Now | ||
| running tests is as simple as issuing this command:: | ||
|
|
||
| $ tox -e pep,py36 | ||
| $ tox -e pep,py39 | ||
|
|
||
| This command will run tests via the "tox" tool against Python 3.6 | ||
| This command will run tests via the "tox" tool against Python 3.9 | ||
| and also perform code style checks. | ||
|
|
||
| #. You can now edit your local working copy and run the tests again as necessary. Please follow PEP-8 recommendations. | ||
|
|
||
| You can pass different options to ``tox``. For example, to run tests on Python 3.6 and pass options to pytest | ||
| You can pass different options to ``tox``. For example, to run tests on Python 3.9 and pass options to pytest | ||
| (e.g. enter pdb on failure) to pytest you can do:: | ||
|
|
||
| $ tox -e py36 -- --pdb | ||
| $ tox -e py39 -- --pdb | ||
|
|
||
| Or to only run tests in a particular test module on Python 3.6:: | ||
| Or to only run tests in a particular test module on Python 3.9:: | ||
|
|
||
| $ tox -e py36 -- tests/test_service.py | ||
| $ tox -e py39 -- tests/test_service.py |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Keep the direct-testing path aligned with Python 3.9.
The tox examples explicitly use py39, but the alternative instructions at Lines 124-131 use generic python3 and pytest. On systems where python3 is another supported version, contributors can follow this path without testing Python 3.9. Specify python3.9 or state that python3 must resolve to Python 3.9.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.rst` around lines 99 - 116, Update the direct-testing
instructions in CONTRIBUTING.rst to invoke Python 3.9 explicitly, using
python3.9 for the relevant commands or clearly stating that python3 must resolve
to Python 3.9; keep the existing test workflow unchanged.
2 participants
Updates to
CONTRIBUTING.rst:masterbranch withdevelopSummary by CodeRabbit
developbranch for feature branches and pull requests.