Skip to content

Make CONTRIBUTING.rst slightly more accurate #429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ableeck wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Make CONTRIBUTING.rst slightly more accurate #429

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions CONTRIBUTING.rst
View file
Open in desktop

@ableeck ableeck Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Both of the changes were made solely on observation. Please feel free to ignore.

Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Here is a simple overview below:

$ git clone git@github.com:YOUR_GITHUB_USERNAME/agent-python-pytest.git
$ cd agent-python-pytest
# now, create your own branch off the "master":
# now, create your own branch off the "develop":

$ git checkout -b your-bugfix-branch-name
Comment on lines +69 to 71

@coderabbitai coderabbitai Bot Jul 30, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

Suggested change
# 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.


Expand Down Expand Up @@ -96,24 +96,24 @@ Here is a simple overview below:

#. Run all the tests

You need to have Python 3.6 available in your system. Now
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
Comment on lines +99 to +116

@coderabbitai coderabbitai Bot Jul 30, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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



When committing, ``pre-commit`` will re-format the files if necessary.
Expand Down Expand Up @@ -143,4 +143,4 @@ Here is a simple overview below:
compare: your-branch-name

base-fork: reportportal/agent-python-pytest
base: master
base: develop
Loading