Browse Source

Add first attempt at a pull request template.

  This introduces the idea of writing changelog entries during
  the release cycle already.

Signed-off-by: Daniel Holbach <daniel@weave.works>
Daniel Holbach 1 year ago
parent
commit
3600b8af61
1 changed files with 29 additions and 0 deletions
  1. 29
    0
      .github/PULL_REQUEST_TEMPLATE.md

+ 29
- 0
.github/PULL_REQUEST_TEMPLATE.md View File

@@ -0,0 +1,29 @@
1
+<!--
2
+
3
+# General contribution criteria
4
+
5
+Please have a look at our contribution guidelines: https://github.com/weaveworks/flux/blob/master/CONTRIBUTING.md
6
+Particularly the sections about the
7
+
8
+- DCO
9
+- contribution workflow and
10
+- how to get your fix accepted
11
+
12
+are important.
13
+
14
+# News
15
+
16
+Please consider adding an entry for either the
17
+
18
+ - regular changelog: https://github.com/weaveworks/flux/blob/master/CHANGELOG.md or
19
+ - helm operator changelog: https://github.com/weaveworks/flux/blob/master/CHANGELOG-helmop.md
20
+
21
+Particularly for ground-breaking changes and new features, it's important to
22
+make users and developers aware of what's changing and where those changes
23
+were documented or discussed.
24
+
25
+Even for smaller changes it's useful to see things documented as well, as it
26
+gives everybody a chance to see at a glance what's coming up in the next
27
+release. It makes the life of the project maintainer a lot easier as well.
28
+
29
+-->

Loading…
Cancel
Save