3 ms·
I agree commit messages are the most important form of documentation. But I disagree about the format. I prefer commit messages like: JIRA-123 one-line 80-
by ajuc 3y ago
I agree commit messages are the most important form of documentation.
But I disagree about the format. I prefer commit messages like:
JIRA-123 one-line 80-char-at-most description
Long description if needed (but preferably keep it in JIRA).
- masklinn 3y ago> but preferably keep it in JIRA Jira is an additional indirection to a tool you will (not might) eventually lose. I’ve seen commits which had lived through 3 VCS transitions. Not only that, but a lot of information is often considered undesirable on tickets.
- computerfriend 3y agoDeeply strange to me that you can think that they're the "most important form of documentation" and then propose to put the documentation elsewhere.
- ajuc 3y agoJIRA contains more context than you can put in even most elaborate comment. For example links to duplicates, test cases, screenshots, core dumps, discussion with testers/customers, etc. And it's updated over time. Would you change the commit message if a tester noticed something about your explanation of the bug was wrong but the fix still works? Additionally the context is already there in the JIRA, retyping it in detail in a different format into the commit message is more friction for little benefit.