File tree Expand file tree Collapse file tree 1 file changed +7
-4
lines changed Expand file tree Collapse file tree 1 file changed +7
-4
lines changed Original file line number Diff line number Diff line change 3
3
Our changelog is automatically generate from individual news entries.
4
4
This alleviates the burden of having to go back and try to figure out
5
5
what changed in a release. It also helps tie pull requests back to the
6
- issue(s) it addresses.
6
+ issue(s) it addresses. Finally, it avoids merge conflicts if multiple
7
+ pull requests try to edit the changelog.
7
8
8
9
## Entries
9
10
10
- Each news entries is represented by a Markdown file that contains the
11
+ Each news entry is represented by a Markdown file that contains the
11
12
relevant details of what changed. The file name of the news entry is
12
- the issue that corresponds to the change along with an option nonce in
13
+ the issue that corresponds to the change along with an optional nonce in
13
14
case a single issue corresponds to multiple changes. The directory
14
15
the news entry is saved in specifies what section of the changelog the
15
- change corresponds to.
16
+ change corresponds to. External contributors should also make sure to
17
+ thank themselves for taking the time and effort to contribute.
16
18
17
19
As an example, a change corresponding to a bug reported in issue #42
18
20
would be saved in the ` 1 Fixes ` directory and named ` 42.md `
@@ -22,6 +24,7 @@ regarding issue #42) and could contain the following:
22
24
``` markdown
23
25
[Answer](https://en.wikipedia.org/wiki/42_(number))
24
26
to the Ultimate Question of Life, the Universe, and Everything!
27
+ (thanks [Don Jaymanne](https://github.com/donjayamanne/))
25
28
```
26
29
27
30
This would then be made into an entry in the changelog that was in the
You can’t perform that action at this time.
0 commit comments