Rework the pull request template to improve documentation and avoid confusion
btlogy opened this issue · comments
b3n commented
Description
The existing PULL_REQUEST_TEMPLATE.md
proposed in the this repository does not seem to be used.
Looking at the recently closed PRs, either the check-boxes for the reviewer(s) were simply ignored, either the whole template was entirely skipped.
In both cases, there is barely any references to an existing issue!
I propose to rework the existing pull request template in order to:
- insist on the need for an issue to be referenced;
- optionally give a better explanation about why and how to fill the form.
Motivation
In short:
- better document why we are changing things;
- reduce the confusion generated by the current template;
Acceptance criteria
Two options. Replace the existing template by:
Additional information
See LeastAuthority/it-ops/issues/145 for the context on this matter.