(public).sospep.events ~ view task ~ CREATE-article-commit-message

<h1 style="text-align: center;">CREATE-article# #</h1>
<h2>[previously]</h2>
<ol>
<li><strong>[2017-09-26][00:00] NEW task IN ?</strong></li>
<ol>
<li>] # 7395 - <a href="/view/task?id=7395" target="_blank">CREATE-article#</a> 5744 (this)&nbsp;</li>
</ol>
<li><strong>[00:00] NEW article IN tech-dev-sw/strategy/index&nbsp;</strong></li>
<ol>
<li>] # 5744 - <a href="/view/article?id=5744" target="_blank">my commit message format</a></li>
</ol></ol>
<h2>[currently]</h2>
<ol>
<li><strong>] NEW task&nbsp;</strong></li>
<ol>
<li><strong>] create draft format outline based upon ...&nbsp;</strong></li>
<li>] title &nbsp;= (WHAT) 'action'- type+scope - subject&nbsp;</li>
<li>] title.example = ADD - feature Employees - new view AddEmployee to enter employee information&nbsp;</li>
<li>] space&nbsp;</li>
<li>] description = (WHY)&nbsp;</li>
<li>] description.example&nbsp;</li>
</ol></ol>
<h2>[next]</h2>
<ol>
<li><strong>] NEW task&nbsp;</strong></li>
<ol>
<li><strong>] review article - ref # 1</strong></li>
<li>] format = title blank line message body&nbsp;</li>
<li>] notes =</li>
<ol>
<li>] example {message}, concise and consistent VS default,&nbsp;</li>
<li>] message establishes "context" (why)</li>
<li>] this requires effort, good collaboration, BUT brings other tools ( git blame, revert, rebase, log, ...) come to life</li>
<li>] "A project&rsquo;s long-term success rests (among other things) on its maintainability, and a maintainer has few tools more powerful than his project&rsquo;s log. It&rsquo;s worth taking the time to learn how to care for one properly. What may be a hassle at first soon becomes habit, and eventually a source of pride and productivity for all involved."</li>
</ol>
<li>] 7 rules -&nbsp;</li>
<ol>
<li>] seperate subject from body with a blank line</li>
<li>] subject (title) length &lt;= 50 characters</li>
<li>] Capitalize the subject line</li>
<li>] do not end the subject line with a period</li>
<li>] use imperative tone for&nbsp;</li>
<li>] body (message) wrapped at 72 characters</li>
<li>] use the body to explain what and why vs how</li>
</ol>
<li>]&nbsp;</li>
</ol>
<li><strong>] NEW task</strong></li>
<ol>
<li><strong>] review article - ref # 2 -&nbsp;<span style="text-decoration: underline;">angular</span> VS react&nbsp;</strong></li>
<li>] format &nbsp;= title /n message&nbsp;</li>
<li>] NG header/title = type scope subject&nbsp;</li>
<li>] ex types = feature, fix, docs, style, refactor, perf, test, chore&nbsp;</li>
<li>] ex scope = application component ( $http, $jqlite, docs, tutorial, ...)</li>
<li>] ex subject &nbsp;=&nbsp;</li>
<li><strong>] angular VS <span style="text-decoration: underline;">react&nbsp;</span></strong></li>
<li>] most common words = <strong>merge</strong>, <strong>pull</strong>, request, <strong>fix</strong>, <strong>add</strong>, <strong>update</strong>, <strong>docs</strong>, <span style="text-decoration: line-through;">react</span>, <strong>test</strong>, <strong>remove</strong>, <span style="text-decoration: line-through;">spicyj</span>, <span style="text-decoration: line-through;">fixes</span>, <span style="text-decoration: line-through;">jsx</span>, patch, <span style="text-decoration: line-through;">1</span></li>
</ol>
<li><strong>] NEW task&nbsp;</strong></li>
<ol>
<li><strong>] review article - ref # 3 - my commit log (project# #)</strong>&nbsp;</li>
</ol>
<li><strong>] NEW task -&nbsp;</strong></li>
<ol>
<li><strong>] my current categories (aka "types" )&nbsp;</strong></li>
<li>] NEW FEATURE&nbsp;</li>
<li>] UPDATE FEATURE</li>
<li>] FIX ISSUE&nbsp;</li>
<li>] CLEANUP&nbsp;</li>
<li>]&nbsp;</li>
</ol>
<li><strong>] NEW task&nbsp;</strong></li>
<ol>
<li><strong>] CREATE-list# # - my current (application) scopes</strong></li>
<li>] specific application menu items - Employees, Employee Groups, Employee Group Types, Equipment, Settings, Window</li>
<li>]&nbsp;</li>
</ol>
<li><strong>] NEW task&nbsp;</strong></li>
<ol>
<li><strong>] CREATE-list# # - common application component types AS "foundation" for "scopes"&nbsp;</strong></li>
<li>] menu, library, version, class, {page / view / tile } , script, class, function, component, dialog, widget/plugin, image,&nbsp;</li>
</ol>
<li><strong>] NEW task&nbsp;</strong></li>
<ol>
<li><strong>] CREATE-list# # - new common "actions"</strong></li>
<li>] common between, ng, re, me, hn.user(),&nbsp;</li>
<li>]&nbsp;</li>
</ol></ol>
<div><hr /></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><span style="font-family: Verdana, Geneva, sans-serif; font-size: 12px; background-color: #f6f6ef;">My team uses a git commit message convention that helps us read fast and also is parsable by toolchains.</span></div>
<div>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">We agree on a short list of leading active verbs:</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;"><strong>Add</strong> = Create a capability e.g. feature, test, dependency.</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">Cut = Remove a capability e.g. feature, test, dependency.</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;"><strong>Fix</strong> = Fix an issue e.g. bug, typo, accident, misstatement.</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">Bump = Increase the version of something e.g. dependency.</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">Make = Change the build process, or tooling, or infra.</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">Start = Begin doing something; e.g. create a feature flag.</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">Stop = End doing something; e.g. remove a feature flag.</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;"><strong>Refactor</strong> = A code change that MUST be just a refactoring.</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">Reformat = Refactor of formatting, e.g. omit whitespace.</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">Optimize = Refactor of performance, e.g. speed up code.</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">Document = Refactor of documentation, e.g. help files.</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">&nbsp;</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">SRC = hn.user() ON&nbsp;</p>
<p style="margin-top: 8px; margin-bottom: 0px; font-family: Verdana, Geneva, sans-serif; font-size: 12px;">&nbsp;</p>
</div>

~ view task ~ TaskGroup] today FROM [ Plan] plan-period IN [ calendars] prj-022-sospep