docs: update CI/CD processes and PR guidelines to resolve #2578 - #2850
Jamessshhh wants to merge 6 commits into
Conversation
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
🟡 Changes recommended
The updated contributor instructions reference pytest and tox, but the repository appears to use unittest and lacks tox configuration, making the guidance inaccurate and likely to fail for contributors.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
This PR updates docs/contributing.md to better document the project’s contributor workflow, including local checks to run before submitting a PR and a clearer set of PR/CI expectations.
Changes:
- Expands the “local testing” step to include explicit commands for linting and running the test suite.
- Adds a consolidated “Pull Request Guidelines and CI/CD Checks” section describing expectations for CI, Python version support, testing, docs, and PR structure.
File summaries
| File | Description |
|---|---|
| docs/contributing.md | Updates contributor instructions and adds a CI/CD + PR expectations section to clarify contribution workflow and requirements. |
Review details
Suppressed comments (1)
docs/contributing.md:119
- The test guidance here references
pytest, but the current test suite usesunittest(and CI runs viapython -m unittest discover). Updating this avoids sending contributors toward a test framework the project doesn’t currently use.
* **Include Tests:** If you are adding a new feature or fixing a bug, include the corresponding `pytest` functions in the `tests/` directory.
* **Reproducibility:** Ensure your tests can be run locally by anyone replicating your environment.
- Files reviewed: 1/1 changed files
- Comments generated: 3
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
| *(Optional but recommended)* Test across multiple Python versions using tox: | ||
| ```bash | ||
| tox | ||
| ``` |
| Run the test suite to ensure no existing features are broken: | ||
| ```bash | ||
| pytest | ||
| ``` |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
for more information, see https://pre-commit.ci
Description
This PR resolves issue #2578 by updating the
docs/contributing.mdfile to clearly outline the repository's current checks, processes, and PR requirements.Changes included:
flake8), the test suite (pytest), and multi-version testing (tox).This should make the contribution workflow much clearer for new developers and help keep the automated pipelines passing.