Skip to content

Update contribution guidelines in pull request template #834

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

Open
julianz- wants to merge 1 commit into
base: main
Choose a base branch
from
+49 −19
Open

Update contribution guidelines in pull request template #834

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
64 changes: 45 additions & 19 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
❓ **What kind of change does this PR introduce?**
<!--
Thank you for your contribution!
Please use our PR template — PRs that strip it will not be reviewed.

Before submitting, please ensure you have:
- Added a change log fragment in docs/changelog-fragments.d/ (see the link in the checklist below)
- Written commits with a clear title and a body explaining the why
- Avoided letting an AI agent strip or overwrite the fields below
-->

## What kind of change does this PR introduce?

* [ ] 🐞 bug fix
* [ ] 🐣 feature
Expand All @@ -7,41 +17,57 @@
* [ ] 📋 refactoring
* [ ] 💥 other

📋 **What is the related issue number (starting with `#`)**

<!-- Are there any issues opened that will be resolved by merging this change? -->
Resolves #<!-- issue number here -->
## What do these changes do?

@webknjaz webknjaz Jul 5, 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.

The pre-existing template used emoji icons for “titles” but didn't use the Markdown heading syntax. And your new changes have it vice versa. This is inconsistent and we should pick one.

@julianz- I recommend that you copy this file into an experimental empty repository and see how it works by simulating the process you expect within that playground to catch such inconsistencies and other UX/DX quirks that may be difficult to spot in a PR review.

@julianz- julianz- Jul 5, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

see https://github.com/julianz-/cheroot-pr-template-test/pull/1


❓ **What is the current behavior?** (You can also link to an open issue here)
<!-- Please give a short brief about these changes. -->

## Are there changes in behavior for the user?

<!-- Outline any notable behavior for the end users. -->

❓ **What is the new behavior (if this is a feature change)?**
## Is it a substantial burden for the maintainers to support this?

<!--
Stop right there! Pause. Just for a minute... Can you think of anything
obvious that would complicate the ongoing development of this project?

Try to consider if you'd be able to maintain it throughout the next
5 years. Does it seem viable? Tell us your thoughts! We'd very much
love to hear what the consequences of merging this patch might be...

📋 **Other information**:
This will help us assess if your change is something we'd want to
entertain early in the review process. Thank you in advance!
-->

## Related issue number

<!-- Will this resolve any open issues? -->
<!-- Remember to prefix with 'Fixes' if it closes an issue (e.g. 'Fixes #123'). -->

📋 **Contribution checklist:**

(If you're a first-timer, check out
[this guide on making great pull requests][making a lovely PR])
## Checklist

* [ ] 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 [changelog][changelog-fragments] 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/

@webknjaz webknjaz Jul 5, 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.

In the future, we should render the CoC in the docs too.

@julianz- julianz- Jul 5, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I added in #835

[CoC]: https://github.com/cherrypy/cheroot?tab=coc-ov-file#readme
[changelog-fragments]:
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]:
Expand Down
4 changes: 4 additions & 0 deletions docs/changelog-fragments.d/834.contrib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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-`.
Loading