Skip to content

Commit ed1b37e

Browse files
axelbocaplaice
andauthored
Update CONTRIBUTING.md
Co-authored-by: aplaice <plaice.adam+github@gmail.com>
1 parent adf054f commit ed1b37e

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ The recommended structure, which can of course be tweaked and expanded as needed
437437

438438
Here are som additional guidelines:
439439

440-
- If the upgrade is non-trivial, make sure to grab users attention with bold text, emojis, etc. at the top of the release notes.
440+
- If the upgrade is non-trivial, make sure to grab users' attention with bold text, emojis, etc. at the top of the release notes.
441441
- Don't write release notes from a contributor's point of view (i.e. one bullet point per pull request/commit/issue), but from a user's point of view (i.e. one bullet point per meaningful change). Indeed, it's common for one change to span multiple pull requests (e.g. new translation followed by various corrections), and it sometimes happens that multiple changes are done with a single pull request.
442442
- Be as specific as possible, for instance by mentioning the country name of the affected note, except when a lot of notes are affected by similar minor changes (like when a lot of typos/mistranslations are fixed in a specific language).
443443
- Always link to relevant issues and pull requests with the `#` syntax.

0 commit comments

Comments
 (0)