Skip to content

Commit 407c6dc

Browse files
authored
Merge pull request #841 from julianz-/docs/contributing-pr-template
Document PR template requirement in CONTRIBUTING.rst
2 parents edef8ff + 8dd6bc7 commit 407c6dc

2 files changed

Lines changed: 21 additions & 2 deletions

File tree

‎.github/CONTRIBUTING.rst‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,18 @@ if applicable and make the GitHub Actions CI/CD build pass.
1616
Sync (preferably rebase) your feature branch with upstream regularly to make
1717
us able to merge your PR seamlessly.
1818

19+
Please fill out the pull request template that GitHub adds to your PR
20+
description automatically when you open one -- it covers what kind of
21+
change you're making, whether it affects user-facing behavior, and a
22+
checklist reviewers expect to be addressed (tests, a ``changelog``
23+
entry, etc.). PRs that skip it may be closed without review.
24+
25+
If you're submitting this PR through an automated or AI-assisted tool
26+
that posts directly via the GitHub API, the pull request template
27+
isn't shown to you automatically the way it would be through the
28+
GitHub web UI. Fetch ``.github/PULL_REQUEST_TEMPLATE.md`` directly
29+
and fill it in yourself.
30+
1931
Submitting bug reports
2032
^^^^^^^^^^^^^^^^^^^^^^
2133

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

2840
Also
2941
^^^^
30-
See `Contributing <https://docs.cherrypy.dev/en/latest/contribute.html>`_ in
31-
the CherryPy docs.
42+
See the `contribution guidelines
43+
<https://cheroot.cherrypy.dev/en/latest/contributing/guidelines/>`_
44+
for more detail, including code style, testing, and the change log
45+
process.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Documented the pull request template requirement in ``.github/CONTRIBUTING.rst``,
2+
including guidance for automated and AI-assisted tools that submit PRs via the
3+
GitHub API, and replaced the outdated CherryPy contributing link with cheroot's
4+
own contribution guidelines
5+
-- by :user:`julianz-`.

0 commit comments

Comments
 (0)