Repository navigation
chore(github): add a release commit-type box to the PR template - #1105
Merged
Merged
Conversation
CONTRIBUTING.md lists release as a commit type, and release: commits exist in the history, but the PR template had no box for it. Add one above chore, which stays last as the catch-all, worded from process.rst's release label definition, and pin the template's boxes against CONTRIBUTING.md's type list in a new tests/project module. Closes #1102
JarryShaw
force-pushed
the
fix/1102-pr-template-release-box
branch
from
October 6, 2026 18:54
39aef27 to
85e5a18
Compare
Owner
Author
|
Cross-review verdict on
|
Contributor
|
Coverage: 88.74% (unit tier, Python 3.14,
Per-file detail: the |
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
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.
Please follow the guide below
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort) — not run; those targets coverpcapkit/only and this touches no library codemake testpasses, and a test case covers the change —tests/projectonly, see belowAdded a changelog entry under
docs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible — N/A, added centrally after the waveWhat is the purpose of your pull request?
Tick the commit type your subject line carries.
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingchore— anything elseDescription of your pull request and other information
Closes #1102
- [ ] `release` — bumps the version or rolls up a distributionabovechore, which stays last as the catch-all.CONTRIBUTING.md:202only names the type, so the wording followsprocess.rst'sreleaselabel row ("version bumps and distribution rollups").tests/project/test_pr_template_commit_types_1102_unit.pychecks that the template's boxes are exactlyCONTRIBUTING.md's type list. Without the fix it fails (1 failed,releasemissing). With the fix it passes (1 passed).test_conventions_doc_claims.py: one docstring line saidreleasehad no tickbox, which is now false. Only the prose changed.pytest tests/project -q:380 passed, 1 skipped, 1286 subtests passed.