manual: Update commit message format #89536
Conversation
| @@ -77,6 +77,11 @@ Additional information. | |||
| <command>firefox: 54.0.1 -> 55.0</command> | |||
| </para> | |||
| </listitem> | |||
| <listitem> | |||
| <para> | |||
| <command>onedrive: 2.3.13 ->! 2.4.2 (Notice the exclamation mark to be used when an update requires user intervention</command> | |||
There was a problem hiding this comment.
I personally think that this syntax rather weird to read. How about sth like this: package: 1.0.0 -> 2.0.0 (breaking) (including further explanation in the release-notes and/or the commit-message)?
Apart from that, I'd suggest to gain more community feedback on this by e.g opening a Discourse thread.
| @@ -59,7 +59,7 @@ | |||
| Format the commit in a following way: | |||
| </para> | |||
| <programlisting> | |||
| (pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc) | |||
| (pkg-name | nixos/<module>): (from -> to | from ->! breaking_update_to | init at version | refactor | etc) | |||
There was a problem hiding this comment.
Don't mix tabs and spaces.
|
I marked this as stale due to inactivity. → More info |
stale
bot
added
the
2.status: stale
|
I like the intention, but this syntax is indeed weird. These days we have a section in the PR template asking to write release notes for breaking changes, I think that's sufficient for now. I know it's not perfect, but it's called unstable for a reason if you're following that. I'll let someone else pick this up if they still find this valuable. For now I don't see much reason to keep it open. |
Motivation for this change
As suggested by @danbst in #83280 (comment), start a convention for commit message format for breaking commits. Implemented here- #89198