Skip to content

Commit 5979d7d

Browse files
h-eastchrisbra
authored andcommitted
PR template duplicates the commit message and needs edits to fill in
Problem: The PR template asks again for what the commit message already provides as the title and description, and its checklist items list alternatives in one line that must be edited instead of ticked. AGENTS.md shows a patch number in the subject, which is added only when merging. Solution: Explain the commit message form in a comment, give each alternative its own checkbox, and drop the patch number from the AGENTS.md example. closes: #21454 Assisted-by: Claude Signed-off-by: Hirohito Higashi <[email protected]> Signed-off-by: Christian Brabandt <[email protected]>
1 parent ea1e40e commit 5979d7d

2 files changed

Lines changed: 32 additions & 37 deletions

File tree

‎.github/pull_request_template.md‎

Lines changed: 31 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,65 +3,60 @@ Thanks for contributing to Vim!
33
44
Please read CONTRIBUTING.md if you have not already. The comments below
55
are not shown in the pull request; delete any section that does not apply.
6-
-->
76
8-
### What does this change do?
7+
Write the commit message in this form:
98
10-
<!--
11-
In one or two sentences, please clearly write what problem this PR fixes.
12-
For visual changes, a before/after screenshot is helpful.
13-
-->
9+
Short description of the problem
1410
15-
### Commit message
11+
Problem: One sentence: what is wrong, from the user's point of view.
12+
Solution: One sentence: what this change does about it (Your Name).
1613
17-
<!--
18-
Changes to the C core are merged with a message in this form.
14+
Anything longer (mechanism, benchmark numbers, why an alternative
15+
was rejected) goes here.
1916
20-
Problem: <one short sentence: what is wrong, from the user's point of view>
21-
Solution: <one short sentence: what this does about it> (Your Name).
17+
fixes: #number
18+
related: #number
2219
23-
Anything longer (mechanism, benchmark numbers, why an alternative was
24-
rejected) goes in the body below the Solution line.
20+
For a pull request with a single commit, GitHub uses the first line as
21+
the title and the rest as the start of this description.
2522
26-
Align the Problem and Solution lines.
23+
For changes to runtime files the first line starts with one of:
2724
28-
Changes to runtime files use the following form:
25+
runtime(doc): for a documentation update
26+
translation(isocode): translations into language
27+
runtime(lang): runtime file changes for language lang
28+
filetype: for changes to filetype detection
2929
30-
runtime(doc): for a documentation update
31-
translation(isocode): translations into language
32-
runtime(lang): runtime file changes for language lang
33-
filetype: for changes to filetype detection
30+
Add "fixes: #number" when this fixes a reported issue, and
31+
"related: #number" when it references another issue or pull request.
32+
"closes: #number" is added when merging.
3433
-->
3534

36-
Problem: Problem line
37-
Solution: Solution line (Your Name).
38-
39-
<!--
40-
If this PR references a previously merged one, add a related: #number
41-
If this PR fixes a reported issue, add a fixes: #number
42-
Keep the closes: header; it is filled in when the PR is merged
43-
44-
Align the # columns
45-
-->
46-
related: #number
47-
fixes: #number
48-
closes: #number
49-
5035
### AI assistance
5136

5237
<!--
5338
Please disclose AI involvement by adding the trailer
5439
"Assisted-by: AI tool".
5540
-->
5641

57-
- [ ] AI involvement is disclosed in the commit message, or no AI was used
42+
- [ ] AI involvement is disclosed in the commit message
43+
- [ ] No AI was used
5844

5945
### Checklist
6046

6147
- [ ] The commit message follows the Problem/Solution form above
6248
- [ ] `Signed-off-by:` trailer is present (`git commit -s`), recommended but not required
63-
- [ ] Tests were added, existing tests cover the change, or the change cannot be tested (say why)
64-
- [ ] Documentation under `runtime/doc/` was updated, or no update is needed
49+
50+
#### Tests
51+
52+
- [ ] Tests were added
53+
- [ ] Existing tests cover the change
54+
- [ ] The change cannot be tested (explain below)
55+
56+
#### Documentation
57+
58+
- [ ] Documentation under `runtime/doc/` was updated
59+
- [ ] No documentation update is needed
6560

6661
### Anything reviewers should know
6762

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Before submitting any patch, at minimum:
7474
Vim uses a strict commit message format. The subject line is a
7575
one-sentence **problem statement**, not a description of the fix:
7676

77-
patch 9.2.NNNN: short description of the problem
77+
short description of the problem
7878

7979
Problem: Restatement of the problem as a full sentence, possibly
8080
with a reporter attribution in parentheses.

0 commit comments

Comments
 (0)