Contributing: Commit message advice#24
Conversation
maksimryndin
left a comment
There was a problem hiding this comment.
Awesome @xrvdg ! 👍
|
Personally, I like this convention https://www.conventionalcommits.org/en/v1.0.0/ with a scope. @xrvdg I had put it as a comment. What do you think? |
I'm not a fan of that convention after having been on a couple of projects that used it. I found the structure to not help me, and even hindering me, in writing informative and succinct commit messages. I like to set context directly at the beginning as it helps me with writing succinct commit message and scanning through commit logs. Context can be seen as scope, but not all projects I've been on see scope in the same way. I dislike the Furthermore this convention tends to come with poor linters making the whole thing a faff. Overly strict on non-important things and messing with what I can write as scope/context. I prefer freer prose with in the the beginning a context keyword the commit author came up with over a rigid structure. |
|
should we merge it @xrvdg ? |
Adds advice on writing commit message to the contributing guide. This PR also acts as a test for the merging strategy to see if it has been setup correctly for smashing fixup commits.
@Oghma feel free to add your suggestions as well.