aboutsummaryrefslogtreecommitdiff
path: root/.github/PULL_REQUEST_TEMPLATE.md
diff options
context:
space:
mode:
authorRobert Hensing <roberth@users.noreply.github.com>2023-01-20 14:36:09 +0100
committerGitHub <noreply@github.com>2023-01-20 14:36:09 +0100
commit04de0dd0b4059c75115c780dae8ddc49a847b0e5 (patch)
treea375ff4b579de35a8873ed931c5f3a9f3b4223f0 /.github/PULL_REQUEST_TEMPLATE.md
parente90d7570a369016f3ce6242c2aefeb43c7d7f881 (diff)
parentdfbdde6d07ebb9a4d637221881d93a485f39714c (diff)
Merge pull request #7577 from hercules-ci/pr-template
.github: Add pull request template
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..a268d7caf
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,28 @@
+# Motivation
+<!-- Briefly explain what the change is about and why it is desirable. -->
+
+# Context
+<!-- Provide context. Reference open issues if available. -->
+
+<!-- Non-trivial change: Briefly outline the implementation strategy. -->
+
+<!-- Invasive change: Discuss alternative designs or approaches you considered. -->
+
+<!-- Large change: Provide instructions to reviewers how to read the diff. -->
+
+# Checklist for maintainers
+
+<!-- Contributors: please leave this as is -->
+
+Maintainers: tick if completed or explain if not relevant
+
+ - [ ] agreed on idea
+ - [ ] agreed on implementation strategy
+ - [ ] tests, as appropriate
+ - functional tests - `tests/**.sh`
+ - unit tests - `src/*/tests`
+ - integration tests
+ - [ ] documentation in the manual
+ - [ ] code and comments are self-explanatory
+ - [ ] commit message explains why the change was made
+ - [ ] new feature or bug fix: updated release notes