Update PR template (#1164)

* Update PR template --------- Co-authored-by: Reynald Affeldt <[email protected]>
math-comp · Jan 25, 2024 · cb51fad · cb51fad
1 parent e2bbd14
commit cb51fad
Showing 1 changed file with 9 additions and 22 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -4,37 +4,24 @@
 
 <!-- you may also explain what remains to do if the fix is incomplete -->
 
-##### Things done/to do
+##### Checklist
 
-<!-- please fill in the following checklist -->
 - [ ] added corresponding entries in `CHANGELOG_UNRELEASED.md`
 
+<!-- rebasing often messes with CHANGELOG_UNRELEASED.md -->
+<!-- consider using a temporary CHANGELOG_PR1234.md instead -->
 <!-- only append to minimize problems when merging/rebasing -->
 <!-- consider the use of `changelog/changes.sh` from
      https://github.com/math-comp/tools to generate the changelog -->
 
 - [ ] added corresponding documentation in the headers
 
-<!-- Cross-out the above items using ~crossed out item~ if they happen not to be relevant -->
+Reference: [How to document](https://github.com/math-comp/math-comp/wiki/How-to-document)
 
-##### Compatibility with MathComp 2.0
+<!-- Cross-out the above items using ~crossed out item~ when irrelevant -->
 
-<!-- MathComp-Analysis is compatible with MathComp < 2.0 (branch `master`) and
-     MathComp 2.0 ([branch `hierarchy-builder`](https://github.com/math-comp/analysis/pull/698)).
+##### Reminder to reviewers
 
-     If this PR targets `master` and if it is merged, the merged commit will also be
-     cherry-picked on the branch `hierarchy-builder`.
-
-     In this case, it would be helpful if the author of the PR also prepares a PR
-     for the branch `hierarchy-builder` or at least warns maintainers with an issue
-     to delegate the work. -->
-
-<!-- use the tag TODO: HB port to record divergences between `master` and `hierarchy-builder` -->
-
-- [ ] I added the label `TODO: HB port` to make sure someone ports this PR to
-      the `hierarchy-builder` branch **or** I already opened an issue or PR (please cross reference).
-
-<!-- leave this note as a reminder to reviewers -->
-##### Automatic note to reviewers
-
-Read [this Checklist](https://github.com/math-comp/math-comp/wiki/Checklist-for-creating-and-review-PRs) and put a milestone if possible.
+- Read [this Checklist](https://github.com/math-comp/math-comp/wiki/Checklist-for-creating-and-review-PRs)
+- Put a milestone if possible
+- Check labels