-
Notifications
You must be signed in to change notification settings - Fork 23
Clarify commit msg format #30
Comments
We relaxed the rules around commit messages for some reasons:
Remaining was something like, |
Yeah, as Patrik mentions we moved away from the cryptic prefixes as it was confusing newcomers a lot. Sounds good @akka/akka-http-team ? |
Ticket number and short description are the only two information that are of actual value according to my experience. |
👍 on ticket number, since it also triggers github auto-linking. Short description requirements are already somewhat mentioned in CONTRIBUTING, but could be more explicit, e.g. "explain why it was changed, since what is changed is visible in the code already". |
https://github.com/akka/akka/blob/master/CONTRIBUTING.md#creating-commits-and-writing-commit-messages currently just states:
When skimming through the commit msgs in the akka and akka-http repos it stands out that they don't adhere to a consistent format.
I suggest we stick to one of the following
<[+-!=]><module-id> #<ticket> <msg>
<msg>, #<ticket>
<msg> (#<ticket>)
and update the contributing guidelines accordingly. (I guess for akka-http it makes sense to just link the akka one.)
The text was updated successfully, but these errors were encountered: