Skip to content

Commit

Permalink
Document release note tags in contributing guide (#1644)
Browse files Browse the repository at this point in the history
RELEASE_NOTES=[DOCUMENTATION] Improve contributing guide.

Signed-off-by: Tom Payne <[email protected]>
  • Loading branch information
twpayne authored Nov 5, 2020
1 parent 2b4e168 commit e10eccf
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,14 @@ will try to clarify it.

More detailed description of commit, if needed.

RELEASE_NOTES=Description for release notes, or n/a if trivial.
RELEASE_NOTES=[TAG] Description for release notes.

Signed-off-by: Your Name <[email protected]>

Valid `[TAG]`s are `[BREAKING]`, `[BUGFIX]`, `[CLEANUP]`, `[DEPRECATION]`,
`[DOCUMENTATION]`, `[ENHANCEMENT]`, `[FEATURE]`, `[TESTING]`, and `[UX]`.
Trivial changes should have no tag and the description `n/a`, i.e.
`RELEASE_NOTES=n/a`.

## Building & Testing

Expand Down

0 comments on commit e10eccf

Please sign in to comment.