Skip to content

Commit 6c8c864

Browse files
authored
Make sure contributors thanks themselves
1 parent dd74ad0 commit 6c8c864

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

news/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,18 @@
33
Our changelog is automatically generate from individual news entries.
44
This alleviates the burden of having to go back and try to figure out
55
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.
78

89
## Entries
910

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
1112
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
1314
case a single issue corresponds to multiple changes. The directory
1415
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.
1618

1719
As an example, a change corresponding to a bug reported in issue #42
1820
would be saved in the `1 Fixes` directory and named `42.md`
@@ -22,6 +24,7 @@ regarding issue #42) and could contain the following:
2224
```markdown
2325
[Answer](https://en.wikipedia.org/wiki/42_(number))
2426
to the Ultimate Question of Life, the Universe, and Everything!
27+
(thanks [Don Jaymanne](https://github.com/donjayamanne/))
2528
```
2629

2730
This would then be made into an entry in the changelog that was in the

0 commit comments

Comments
 (0)