When I write commit messages I add a “team” prefix to the message,
ortest` followed by a colon, space, and
then message. e.g.
admin: Updated README to explain new config options
That’s worked well for me personally, as it allows me to sort commit
messages by category. But recently I’ve started to really give YARD a
shake for documenting my code, and I’ve toyed with the idea of
changing my commit messages to reflect YARD style:
@admin Updated README to explain new config options
I’m not sure I like that as much though.
Are there any known conventions for this sort of thing? Anyone else
have suggestions or personal conventions for commit messages that they