Commit 23d6339
authored
PR: Add a pull request template (#8749)
## What this changes
MegaMek has no pull request template, so the box is empty when you open
a PR. This adds one. It is a prompt, not a gate - GitHub has no required
fields for pull requests, so anything here can be deleted by the author.
The content is taken from what the project already asks for rather than
from a generic checklist. Three things it addresses, each measured
against the last 50 merged PRs:
**The title convention is documented but almost unused.**
`Commit-Procedures` on the wiki says titles start with `Fix:` for a bug
fix or `PR:` for a feature, because release notes are generated
automatically from PR titles. Four of the last fifty MegaMek PRs did
that. Release notes are currently being built from titles like
"F_PHYSICAL_WEAPON". The reminder is the first thing in the template, in
a comment, because a template cannot set the title itself.
**Only five of the last fifty linked an issue** with a closing keyword,
so issues are not closing themselves. `Fixes #` now sits directly under
the summary.
**AI disclosure is project policy.** The wiki's AI tool guidelines
require that any PR involving AI tools be labelled, and that the
submitting developer be able to explain and verify the result. The
checklist says so and links the page.
## Testing
Rendered the Markdown to check the comment blocks disappear and the
checklist renders as checkboxes. The template cannot be seen in the pull
request composer until it is on the default branch, which is the same
constraint the issue templates had.
## What is not proven yet
Whether it actually helps. That is the point of trying it in MegaMek
alone before MegaMekLab, MekHQ and mm-data - if it turns out to be
noise, or people delete it wholesale, it is one file to revise or
remove.
The four checklist items are drawn from what reviewers have been
flagging, but the list is deliberately short. A long checklist gets
ticked without being read, which is exactly why the mandatory Discord
confirmation came out of the bug report form.
Two related corrections are worth making separately, since they are wiki
edits rather than repository changes: the AI guidelines name labels
called "AI Code" and "AI Data" which do not exist - the real ones are
`AI Assisted Development` and `AI ready for Review` - and the outside
contributor page still tells people to target the `master` branch.1 file changed
Lines changed: 62 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
0 commit comments