edit-article

Article Description: ] my-commit-message-format - my attempt to create a consistent and concise format for composing software development project "commit messages", based on

Chapter ID/Name:

Status: Write Writing Written

Add Photo:

Owner ID:

Content: use HTML Edit Content <h1 style="text-align: center;">my commit message format</h1> <h2>[WHAT]</h2> <ol> <li>] by Don Sagrott, founder @ sospep.com - &nbsp;my take on crafting consistent, informative, commit messages the will tell the story of your software development project and project, &nbsp;</li> <li>] facilitate the use of git tools like ...&nbsp;</li> <li>] can be re used for / release notes, / project - planning&nbsp;</li> <li>] this article was compiled from the works of several others who have gone before me with great commitments to the cause of crafting better commit messages</li> </ol> <h2>[WHY]</h2> <ol> <li>]&nbsp;to create a consistent and concise format for composing software development project "commit messages"&nbsp;</li> <li>] commit message should explain the "what" and the "why" of change to the existing code body</li> <li>] the code itself( commented of course) would explain the "how"&nbsp;</li> </ol> <h2>[WHERE]</h2> <ol> <li><strong>] READ THE FULL ARTICLE</strong></li> <ol> <li>] see below&nbsp;</li> </ol></ol> <h2>[WHEN]</h2> <ol> <li>] 2017-mm-dd</li> </ol> <h2>[EXAMPLE]</h2> <ol> <li>[s] ADD FEATURE - Employee Detail - new option to enter multiple employee email addresses&nbsp;</li> <li>[]&nbsp;</li> <li>[b]</li> <li>[]</li> <li>[f] &nbsp;</li> </ol> <h2>[HOW-TO]</h2> <ol> <li>]&nbsp;</li> <li>] defining your scopes -</li> <li>] crafting the right subject message - &nbsp;</li> </ol> <h2>[REFERENCE]</h2> <ol> <li>] # 7395 -&nbsp;<a href="/view/task?id=7395" target="_blank">CREATE-article#</a>&nbsp;5744 (this)&nbsp;</li> <li>]&nbsp;<a href="https://chris.beams.io/posts/git-commit/" target="_blank">how to write a Git commit message</a>&nbsp;-&nbsp;chris beams (2014) - article on creating git commit messages,&nbsp;</li> <li>]&nbsp;<a href="https://medium.com/@sAbakumoff/angular-vs-react-text-analysis-of-commit-messages-1cda199f3bdb" target="_blank">angular VS react</a>&nbsp;- analysis of the content of thousands of commit messages</li> <li>] hn user() comment ( see below )- another method</li> <li>] my previous commit messages - ref gm, wk</li> </ol> <h1 style="text-align: center;">&nbsp;</h1>