diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 15aa74f76e..c858cb5891 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,50 +3,35 @@ Thanks for contributing to Vim! Please read CONTRIBUTING.md if you have not already. The comments below are not shown in the pull request; delete any section that does not apply. + +Write the commit message in this form: + + Short description of the problem + + Problem: One sentence: what is wrong, from the user's point of view. + Solution: One sentence: what this change does about it (Your Name). + + Anything longer (mechanism, benchmark numbers, why an alternative + was rejected) goes here. + + fixes: #number + related: #number + +For a pull request with a single commit, GitHub uses the first line as +the title and the rest as the start of this description. + +For changes to runtime files the first line starts with one of: + + runtime(doc): for a documentation update + translation(isocode): translations into language + runtime(lang): runtime file changes for language lang + filetype: for changes to filetype detection + +Add "fixes: #number" when this fixes a reported issue, and +"related: #number" when it references another issue or pull request. +"closes: #number" is added when merging. --> -### What does this change do? - - - -### Commit message - - - - Problem: Problem line - Solution: Solution line (Your Name). - - -related: #number -fixes: #number -closes: #number - ### AI assistance -- [ ] AI involvement is disclosed in the commit message, or no AI was used +- [ ] AI involvement is disclosed in the commit message +- [ ] No AI was used ### Checklist - [ ] The commit message follows the Problem/Solution form above - [ ] `Signed-off-by:` trailer is present (`git commit -s`), recommended but not required -- [ ] Tests were added, existing tests cover the change, or the change cannot be tested (say why) -- [ ] Documentation under `runtime/doc/` was updated, or no update is needed + +#### Tests + +- [ ] Tests were added +- [ ] Existing tests cover the change +- [ ] The change cannot be tested (explain below) + +#### Documentation + +- [ ] Documentation under `runtime/doc/` was updated +- [ ] No documentation update is needed ### Anything reviewers should know diff --git a/AGENTS.md b/AGENTS.md index b8e595713a..42c370b734 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -74,7 +74,7 @@ Before submitting any patch, at minimum: Vim uses a strict commit message format. The subject line is a one-sentence **problem statement**, not a description of the fix: - patch 9.2.NNNN: short description of the problem + short description of the problem Problem: Restatement of the problem as a full sentence, possibly with a reporter attribution in parentheses.