From 26d921c2d439b9e50d9bbad7af8ecb74b2b36362 Mon Sep 17 00:00:00 2001 From: julianz- <6255571+julianz-@users.noreply.github.com> Date: Sun, 5 Jul 2026 02:06:13 -0700 Subject: [PATCH 1/2] Update contribution guidelines in pull request template Revise the PR template incorporating elements from webknjaz's tox-towncrier template, adding a warning block with mandatory contribution rules, a changelog entry checkbox linking to the fragment guidelines, improved commit message guidance, and updated reference links. --- .github/PULL_REQUEST_TEMPLATE.md | 61 ++++++++++++++++------ docs/changelog-fragments.d/834.contrib.rst | 4 ++ 2 files changed, 48 insertions(+), 17 deletions(-) create mode 100644 docs/changelog-fragments.d/834.contrib.rst diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bdeee9949d..16f56c8016 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,10 @@ -❓ **What kind of change does this PR introduce?** + + +## What kind of change does this PR introduce? * [ ] 🐞 bug fix * [ ] 🐣 feature @@ -7,41 +13,62 @@ * [ ] 📋 refactoring * [ ] 💥 other -📋 **What is the related issue number (starting with `#`)** +## What do these changes do? - -Resolves # + -❓ **What is the current behavior?** (You can also link to an open issue here) +## Are there changes in behavior for the user? + +## Is it a substantial burden for the maintainers to support this? -❓ **What is the new behavior (if this is a feature change)?** + -📋 **Other information**: +## Related issue number + + +## Checklist -📋 **Contribution checklist:** + -(If you're a first-timer, check out -[this guide on making great pull requests][making a lovely PR]) +> [!tip] +> New to open source contributions? [Making a lovely PR][making a lovely PR] is a great read. * [ ] I wrote descriptive pull request text above +* [ ] The PR relates to *only* one subject with a clear title + and description in grammatically correct, complete sentences * [ ] I think the code is well written -* [ ] I wrote [good commit messages] -* [ ] I have [squashed related commits together][related squash] after - the changes have been approved * [ ] Unit tests for the changes exist * [ ] Integration tests for the changes exist (if applicable) * [ ] I used the same coding conventions as the rest of the project * [ ] The new code doesn't generate linter offenses -* [ ] Documentation reflects the changes -* [ ] The PR relates to *only* one subject with a clear title - and description in grammatically correct, complete sentences - +* [ ] Project documentation (in `docs/`) and inline docstrings reflect the changes +* [ ] My commits each have a descriptive title and a body explaining the why + (see [guide][good commit messages]) +* [ ] I have added a [change log entry] + (can be done once the PR number is known) +* [ ] I'm planning to [squash related commits together][related squash] + before final merge +* [ ] I have read the [contribution guide][CONTRIBUTING] and the + [code of conduct][CoC] + +[CONTRIBUTING]: https://cheroot.cherrypy.dev/en/latest/contributing/guidelines/ +[CoC]: https://github.com/cherrypy/cheroot?tab=coc-ov-file#readme +[change log entry]: +https://github.com/cherrypy/cheroot/tree/main/docs/changelog-fragments.d#readme [good commit messages]: http://chris.beams.io/posts/git-commit/ [making a lovely PR]: https://mtlynch.io/code-review-love/ [related squash]: diff --git a/docs/changelog-fragments.d/834.contrib.rst b/docs/changelog-fragments.d/834.contrib.rst new file mode 100644 index 0000000000..43db925f0d --- /dev/null +++ b/docs/changelog-fragments.d/834.contrib.rst @@ -0,0 +1,4 @@ +Updated the pull request template with consistent heading structure, +a change log entry checkbox linking to the change log guidelines, +and improved commit message guidance +-- by :user:`julianz-`. From 71c45d9d1bebbb49197446aa15f3002e9e6e5b2f Mon Sep 17 00:00:00 2001 From: julianz- <6255571+julianz-@users.noreply.github.com> Date: Wed, 8 Jul 2026 10:56:36 -0700 Subject: [PATCH 2/2] Revise checkboxes in the template Simplified link references to use implicit labels where the link text matches the definition. Added a hint that a related issue number can be used for the change log entry before a PR number is known. --- .github/PULL_REQUEST_TEMPLATE.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 16f56c8016..ab5c1af86e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -45,7 +45,7 @@ entertain early in the review process. Thank you in advance! > [!tip] -> New to open source contributions? [Making a lovely PR][making a lovely PR] is a great read. +> New to open source contributions? [Making a lovely PR] is a great read. * [ ] I wrote descriptive pull request text above * [ ] The PR relates to *only* one subject with a clear title @@ -57,19 +57,20 @@ entertain early in the review process. Thank you in advance! * [ ] The new code doesn't generate linter offenses * [ ] Project documentation (in `docs/`) and inline docstrings reflect the changes * [ ] My commits each have a descriptive title and a body explaining the why - (see [guide][good commit messages]) + (see [good commit messages]) * [ ] I have added a [change log entry] - (can be done once the PR number is known) -* [ ] I'm planning to [squash related commits together][related squash] - before final merge -* [ ] I have read the [contribution guide][CONTRIBUTING] and the + (can be done once the PR number is known; alternatively, you can + use a related issue number if one exists) +* [ ] I'm planning to [squash related commits] together before final merge +* [ ] I have read the [contribution guide] and the [code of conduct][CoC] -[CONTRIBUTING]: https://cheroot.cherrypy.dev/en/latest/contributing/guidelines/ +[contribution guide]: +https://cheroot.cherrypy.dev/en/latest/contributing/guidelines/ [CoC]: https://github.com/cherrypy/cheroot?tab=coc-ov-file#readme [change log entry]: https://github.com/cherrypy/cheroot/tree/main/docs/changelog-fragments.d#readme [good commit messages]: http://chris.beams.io/posts/git-commit/ -[making a lovely PR]: https://mtlynch.io/code-review-love/ -[related squash]: +[Making a lovely PR]: https://mtlynch.io/code-review-love/ +[squash related commits]: https://github.com/todotxt/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit