Commit: Add a PR template

3 views
Skip to first unread message

Christian Brabandt

unread,
Sep 28, 2026, 4:15:14 PM (4 days ago) Sep 28
to vim...@googlegroups.com
Add a PR template

Commit: https://github.com/vim/vim/commit/69180073f228863592064126ce1045c853529252
Author: Christian Brabandt <c...@256bit.org>
Date: Mon Sep 28 19:59:48 2026 +0000

Add a PR template

closes: https://github.com/vim/vim/issues/21321

Signed-off-by: Christian Brabandt <c...@256bit.org>

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..90aed2c2e
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,71 @@
+<!--
+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.
+-->
+
+### What does this change do?
+
+<!--
+One or two sentences, please clearly write what problem this PR fixes,
+for visual changes, a before/after screenshot is helpful
+ -->
+
+### Commit message
+
+<!--
+Changes to the C core are merged with a message in this form.
+
+ Problem: <one short sentence: what is wrong, from the user's point of view>
+ Solution: <one short sentence: what this does about it>
+
+Anything longer (mechanism, benchmark numbers, why an alternative was
+rejected) goes in the body below the Solution line.
+
+Align the Problem and Solution lines.
+
+Changes to runtime files use the following form:
+
+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
+-->
+
+ Problem: Problem line
+ Solution: Solution line
+
+<!--
+If this PR references a previously merged one, add a references: #number
+If this PR fixes a reported issue, add a fixes: #number
+Keep the closes: header, it will be filled out when merging the PR
+
+Align the # columns
+-->
+related: #number
+fixes: #number
+closes: #number
+
+### AI assistance
+
+<!--
+Please disclose AI involvement by adding the trailer
+ "Assisted-by: AI tool".
+-->
+
+- [ ] AI involvement is disclosed in the commit message, or no AI was used
+
+### Checklist
+
+- [ ] The commit message follows the Problem/Solution form above
+- [ ] `Signed-off-by:` trailer is present (`git commit -s`)
+- [ ] Tests were added, existing tests cover the change, or the change cannot be tested (say why)
+- [ ] Documentation under `runtime/doc/` was updated
+
+### Anything reviewers should know
+
+<!--
+For example: a behaviour change users may notice, a platform you could
+not test on, or an assumption the change relies on.
+-->
Reply all
Reply to author
Forward
0 new messages