Skip to content

Commit 2ac700e

Browse files
committed
doc: Update the CONTRIBUTING.md to follow Conventional Commits
Following this convention will let NuttX commits to be easily parsed by standard tools: https://www.conventionalcommits.org/en/v1.0.0/ Signed-off-by: Alan C. Assis <[email protected]>
1 parent 41eaa50 commit 2ac700e

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -285,8 +285,11 @@ We avoid breaking changes unless absolutely necessary and unavoidable
285285
8. Change must be well documented (build / runtime test logs, pr, git
286286
commit, documentation, release notes, etc) with clear notes on how to
287287
fix the introduced problems.
288-
9. Breaking Change must be clearly marked with a `[BREAKING]` tag in the
289-
git commit topic and PR title that will propagate to Release Notes.
288+
9. Breaking Change must be clearly identified with inclusion of the an
289+
exclamation mark `!` as first character of the commit title and a
290+
`BREAKING CHANGE:` in the git commit log message, followed by a short
291+
comment about way user will use it currently. This change description
292+
will be used to create the Release Notes.
290293

291294
See: https://github.com/apache/nuttx/blob/master/INVIOLABLES.md
292295

0 commit comments

Comments
 (0)