Browse Source

Soften the changelog requirement for PRs

I'd rather people wrote their suggestion for the changelog in the PR
description, rather than including it in the commits. I ened up
looking through the PRs anyway, and this way we don't have to keep a
"staging area" for the next release in the changelog.
Michael Bridgen 1 year ago
parent
commit
945a396507
1 changed files with 7 additions and 15 deletions
  1. 7
    15
      .github/PULL_REQUEST_TEMPLATE.md

+ 7
- 15
.github/PULL_REQUEST_TEMPLATE.md View File

@@ -1,24 +1,17 @@
1 1
 <!--
2
-
3 2
 # General contribution criteria
4 3
 
5 4
 Please have a look at our contribution guidelines: https://github.com/weaveworks/flux/blob/master/CONTRIBUTING.md
6 5
 Particularly the sections about the:
7
-- DCO
8
-- contribution workflow and
9
-- how to get your fix accepted
10
-
11
-
12
-# News
13 6
 
14
-Please consider adding an entry for either the
7
+ - DCO;
8
+ - contribution workflow; and
9
+ - how to get your fix accepted
15 10
 
16
- - regular changelog: https://github.com/weaveworks/flux/blob/master/CHANGELOG.md or
17
- - helm operator changelog: https://github.com/weaveworks/flux/blob/master/CHANGELOG-helmop.md
18
-
19
-In your PR, just add a short description of your change with a link to the
20
-relevant discussion. (You can find CHANGELOG.md and CHANGELOG-helmop.md in the
21
-top-level directory.)
11
+To help the maintainers out when they're writing release notes, please
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.
22 15
 
23 16
 Particularly for ground-breaking changes and new features, it's important to
24 17
 make users and developers aware of what's changing and where those changes
@@ -27,5 +20,4 @@ were documented or discussed.
27 20
 Even for smaller changes it's useful to see things documented as well, as it
28 21
 gives everybody a chance to see at a glance what's coming up in the next
29 22
 release. It makes the life of the project maintainer a lot easier as well.
30
-
31 23
 -->

Loading…
Cancel
Save