hartmannathan commented on code in PR #16823:
URL: https://github.com/apache/nuttx/pull/16823#discussion_r2271036411
##########
CONTRIBUTING.md:
##########
@@ -285,8 +285,11 @@ We avoid breaking changes unless absolutely necessary and
unavoidable
8. Change must be well documented (build / runtime test logs, pr, git
commit, documentation, release notes, etc) with clear notes on how to
fix the introduced problems.
- 9. Breaking Change must be clearly marked with a `[BREAKING]` tag in the
- git commit topic and PR title that will propagate to Release Notes.
+ 9. Breaking Change must be clearly identified with inclusion of the an
+ exclamation mark `!` as first character of the commit title and a
+ `BREAKING CHANGE:` in the git commit log message, followed by a short
+ comment about way user will use it currently. This change description
+ will be used to create the Release Notes.
Review Comment:
Suggestion:
```suggestion
9. Breaking change must be clearly identified with inclusion of an
exclamation mark `!` as the first character of the commit title and a
`BREAKING CHANGE:` in the git commit log message, followed by a short
comment about how the user should adapt their code. This change
description will be used to create the Release Notes.
```
Thoughts?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
