Document PR template requirement in CONTRIBUTING.rst - #841
Merged
Merged
Conversation
psf-chronographer
Bot
added
the
bot:chronographer:provided
Documentation build overview
10 files changed ·
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #841 +/- ##
==========================================
- Coverage 78.37% 78.16% -0.21%
==========================================
Files 41 41
Lines 4791 4791
Branches 548 548
==========================================
- Hits 3755 3745 -10
- Misses 899 906 +7
- Partials 137 140 +3 |
Neither CONTRIBUTING.rst nor guidelines.rst mentioned the PR template, so contributors, especially agent-driven ones using the API, often skip it. Add a note about it, and fix the stale link to CherryPy's contributing page.
julianz-
force-pushed
the
docs/contributing-pr-template
branch
from
September 18, 2026 20:44
8d9a789 to
8dd6bc7
Compare
webknjaz
reviewed
Sep 19, 2026
|
|
||
| Also | ||
| ^^^^ | ||
| See `Contributing <https://docs.cherrypy.dev/en/latest/contribute.html>`_ in |
Member
There was a problem hiding this comment.
Ideally, it'd be nice to still have a copy in one place, but I guess it's fine for now.
webknjaz
reviewed
Sep 19, 2026
| If you're submitting this PR through an automated or AI-assisted tool | ||
| that posts directly via the GitHub API, the pull request template | ||
| isn't shown to you automatically the way it would be through the | ||
| GitHub web UI. Fetch ``.github/PULL_REQUEST_TEMPLATE.md`` directly |
Member
There was a problem hiding this comment.
RST has :file: roles FTR
Suggested change
| GitHub web UI. Fetch ``.github/PULL_REQUEST_TEMPLATE.md`` directly | |
| GitHub web UI. Fetch :file:`.github/PULL_REQUEST_TEMPLATE.md` directly |
webknjaz
reviewed
Sep 19, 2026
| checklist reviewers expect to be addressed (tests, a ``changelog`` | ||
| entry, etc.). PRs that skip it may be closed without review. | ||
|
|
||
| If you're submitting this PR through an automated or AI-assisted tool |
Member
There was a problem hiding this comment.
Agents are unlikely to read these instructions w/o them being included into an AGENTS.md file but it's fine for now.
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
2 participants
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.
Neither CONTRIBUTING.rst nor guidelines.rst mentioned the PR template, so contributors, especially agent-driven ones using the API, often skip it. Add a note about it, and fix the stale link to CherryPy's contributing page.
What kind of change does this PR introduce?
What do these changes do?
Documents the pull request template requirement in
.github/CONTRIBUTING.rst,which currently isn't mentioned anywhere in our contributing docs. Also adds a
note for contributors using automated or AI-assisted tools that submit PRs via
the GitHub API, since the template isn't shown to them the way it is through
the web UI. Replaces the stale link to CherryPy's generic contributing page
with cheroot's own contribution guidelines.
Are there changes in behavior for the user?
None — this only affects contributors opening PRs, not end users of cheroot.
Is it a substantial burden for the maintainers to support this?
No, it's a small documentation-only change with no ongoing maintenance cost.
Related issue number
None
Checklist
and description in grammatically correct, complete sentences
docs/) and inline docstrings reflect the changes(see [good commit messages])
(can be done once the PR number is known; alternatively, you can
use a related issue number if one exists)
[code of conduct][CoC]