Skip to content

Document PR template requirement in CONTRIBUTING.rst #841

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

Merged
webknjaz merged 1 commit into from
Sep 19, 2026
+21 −2
Merged

Document PR template requirement in CONTRIBUTING.rst #841

Show file tree
Hide file tree
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: 16 additions & 2 deletions .github/CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ if applicable and make the GitHub Actions CI/CD build pass.
Sync (preferably rebase) your feature branch with upstream regularly to make
us able to merge your PR seamlessly.

Please fill out the pull request template that GitHub adds to your PR
description automatically when you open one -- it covers what kind of
change you're making, whether it affects user-facing behavior, and a
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

@webknjaz webknjaz Sep 19, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Agents are unlikely to read these instructions w/o them being included into an AGENTS.md file but it's fine for now.

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

@webknjaz webknjaz Sep 19, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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

and fill it in yourself.

Submitting bug reports
^^^^^^^^^^^^^^^^^^^^^^

Expand All @@ -27,5 +39,7 @@ post a markdown snippet demonstrating minimum reproducible example of an issue.

Also
^^^^
See `Contributing <https://docs.cherrypy.dev/en/latest/contribute.html>`_ in

@webknjaz webknjaz Sep 19, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ideally, it'd be nice to still have a copy in one place, but I guess it's fine for now.

the CherryPy docs.
See the `contribution guidelines
<https://cheroot.cherrypy.dev/en/latest/contributing/guidelines/>`_
for more detail, including code style, testing, and the change log
process.
5 changes: 5 additions & 0 deletions docs/changelog-fragments.d/841.contrib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Documented the pull request template requirement in ``.github/CONTRIBUTING.rst``,
including guidance for automated and AI-assisted tools that submit PRs via the
GitHub API, and replaced the outdated CherryPy contributing link with cheroot's
own contribution guidelines
-- by :user:`julianz-`.
Loading