acassis commented on PR #16823: URL: https://github.com/apache/nuttx/pull/16823#issuecomment-3172089387
> We also need "!" mark before ":" in the git commit topic for breaking changes as stated by [1]. Otherwise we are hiding breaking changes and this is not the goal, these should be clearly visible. > > [1] https://www.conventionalcommits.org/en/v1.0.0/ > * Thanks @acassis, since requirement for marking breaking changes is part of Contributing Guide for 3 months but everyone seems to ignore marking, maybe other way will work. > > * There is nothing wrong in `[BREAKING]` mark, no bad message, quite opposite, someone who finds their code broken after update will easily find possible cause that way. > > * I do insist to mark breaking changes in git commit topic and PR message title as this is first place to search (git log search and changelog). > @cederom the issues are those I submitted to the mailing list: - It passes a wrong message, as something very negative (not all breaking are bad, or shouldn't be) - Someone reading our git history could get a wrong impression of the project - It will cluttering the title, by convention the title should have only 50 chars - It doesn't follow the conventional commits specification: https://www.conventionalcommits.org/en/v1.0.0/ > * Putting "BREAKING CHANGE" in the git commit message may be okay, but we also need this "!" mark before ":" as stated in https://www.conventionalcommits.org/en/v1.0.0/. It is not mandatory: please see items 12 and 13 of specification. If "!" is included in the commit title the "BREAKING CHANGE: " in the foot are not required. Just it! :-) -- 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: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
