Browse Source

Add short quality checklist to pull request templ

Hidde Beydals 1 year ago
parent
commit
d0a48552cc
1 changed files with 12 additions and 2 deletions
  1. 12
    2
      .github/PULL_REQUEST_TEMPLATE.md

+ 12
- 2
.github/PULL_REQUEST_TEMPLATE.md View File

@@ -10,8 +10,7 @@ Particularly the sections about the:
10 10
 
11 11
 To help the maintainers out when they're writing release notes, please
12 12
 try to include a sentence or two here describing your change for end
13
-users. See the CHANGELOG.md and CHANGELOG-helmop.md files in the
14
-top-level directory for examples.
13
+users. See the CHANGELOG.md file in the top-level directory for examples.
15 14
 
16 15
 Particularly for ground-breaking changes and new features, it's important to
17 16
 make users and developers aware of what's changing and where those changes
@@ -20,4 +19,15 @@ were documented or discussed.
20 19
 Even for smaller changes it's useful to see things documented as well, as it
21 20
 gives everybody a chance to see at a glance what's coming up in the next
22 21
 release. It makes the life of the project maintainer a lot easier as well.
22
+
23
+The following short checklist can be used to make sure your PR is of good
24
+quality, and can be merged easily:
25
+
26
+- [ ] if it resolves an issue;
27
+      is a reference (i.e. #1) to this issue included?
28
+- [ ] if it introduces a new functionality or configuration flag;
29
+      did you document this in the references or guides?
30
+- [ ] optional but much appreciated;
31
+      do you think many users would profit from a dedicated setting
32
+      for this functionality in the Helm chart?
23 33
 -->

Loading…
Cancel
Save