task

CREATE-article# #

[previously]

  1. [2017-09-26][00:00] NEW task IN ?
    1. ] # 7395 - CREATE-article# 5744 (this) 
  2. [00:00] NEW article IN tech-dev-sw/strategy/index 
    1. ] # 5744 - my commit message format

[currently]

  1. ] NEW task 
    1. ] create draft format outline based upon ... 
    2. ] title  = (WHAT) 'action'- type+scope - subject 
    3. ] title.example = ADD - feature Employees - new view AddEmployee to enter employee information 
    4. ] space 
    5. ] description = (WHY) 
    6. ] description.example 

[next]

  1. ] NEW task 
    1. ] review article - ref # 1
    2. ] format = title blank line message body 
    3. ] notes =
      1. ] example {message}, concise and consistent VS default, 
      2. ] message establishes "context" (why)
      3. ] this requires effort, good collaboration, BUT brings other tools ( git blame, revert, rebase, log, ...) come to life
      4. ] "A project’s long-term success rests (among other things) on its maintainability, and a maintainer has few tools more powerful than his project’s log. It’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."
    4. ] 7 rules - 
      1. ] seperate subject from body with a blank line
      2. ] subject (title) length <= 50 characters
      3. ] Capitalize the subject line
      4. ] do not end the subject line with a period
      5. ] use imperative tone for 
      6. ] body (message) wrapped at 72 characters
      7. ] use the body to explain what and why vs how
  2. ] NEW task
    1. ] review article - ref # 2 - angular VS react 
    2. ] format  = title /n message 
    3. ] NG header/title = type scope subject 
    4. ] ex types = feature, fix, docs, style, refactor, perf, test, chore 
    5. ] ex scope = application component ( $http, $jqlite, docs, tutorial, ...)
    6. ] ex subject  = 
    7. ] angular VS react 
    8. ] most common words = merge, pull, request, fix, add, update, docs, react, test, remove, spicyj, fixes, jsx, patch, 1
  3. ] NEW task 
    1. ] review article - ref # 3 - my commit log (project# #) 
  4. ] NEW task - 
    1. ] my current categories (aka "types" ) 
    2. ] NEW FEATURE 
    3. ] UPDATE FEATURE
    4. ] FIX ISSUE 
    5. ] CLEANUP 
  5. ] NEW task 
    1. ] CREATE-list# # - my current (application) scopes
    2. ] specific application menu items - Employees, Employee Groups, Employee Group Types, Equipment, Settings, Window
  6. ] NEW task 
    1. ] CREATE-list# # - common application component types AS "foundation" for "scopes" 
    2. ] menu, library, version, class, {page / view / tile } , script, class, function, component, dialog, widget/plugin, image, 
  7. ] NEW task 
    1. ] CREATE-list# # - new common "actions"
    2. ] common between, ng, re, me, hn.user(), 

 
 
 
 
My team uses a git commit message convention that helps us read fast and also is parsable by toolchains.

We agree on a short list of leading active verbs:

Add = Create a capability e.g. feature, test, dependency.

Cut = Remove a capability e.g. feature, test, dependency.

Fix = Fix an issue e.g. bug, typo, accident, misstatement.

Bump = Increase the version of something e.g. dependency.

Make = Change the build process, or tooling, or infra.

Start = Begin doing something; e.g. create a feature flag.

Stop = End doing something; e.g. remove a feature flag.

Refactor = A code change that MUST be just a refactoring.

Reformat = Refactor of formatting, e.g. omit whitespace.

Optimize = Refactor of performance, e.g. speed up code.

Document = Refactor of documentation, e.g. help files.

 

SRC = hn.user() ON 

 

Details Photos Edit more

Details

ID: 7395

NAME: CREATE-article-commit-message

DESCRIPTION: ] # # - CREATE-article# # - commit-message-format

START DATE TIME: 2017-09-26 23:28:27

EST DURATION: 01:00:00

END DATE TIME: 2017-09-27 00:28:27

STATUS: To-Do

PRIORITY: -5

OWNER ID: 1

Content Photos Edit more

photos

photos for this task

actions

Agenda Email task SMS task Priorities