d-simon · December 22, 2016 03:05 · Apr 25, 2015 · Apr 25, 2015 · Apr 25, 2015 · Apr 25, 2015
diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -4,7 +4,7 @@ This is a *revamped* proposal for structuring commit messages. It is a set of gu
 #Structure
 
 ```
-Action|Scope: Summary
+[Action] Scope: Summary
 
 Detailed Body Text (if necessary)
 
@@ -49,14 +49,14 @@ This is a list of proposed action keywords. It is in no way a definitive list. R
 
 ## Samples
 ```
-Feature|Header: Add header element
+[Merge] Header: Add header element
 
-Update|header: Move main-nav a bit to the bottom
-Update|service-nav: Add structure/module file
-Fix|Reference: Change reference from all.scss to main.scss in index.html.erb.
-Refactor|Structure: Move styles for main-nav / header into their own files
-Update|Header: Initial strucutre
-Update|Grid: Adjust breakpoints / Import container size configuration
+[Update] header: Move main-nav a bit to the bottom
+[Update] service-nav: Add structure/module file
+[Fix] Reference: Change reference from all.scss to main.scss in index.html.erb.
+[Refactor] Structure: Move styles for main-nav / header into their own files
+[Update] Header: Initial strucutre
+[Update] Grid: Adjust breakpoints / Import container size configuration
 
 Conflicts:
 source/assets/css/main.sass
@@ -67,13 +67,13 @@ source/index.html.erb
 ```
 
 ```
-Fix|serviceBus: Add missing check for argument of complete() method
+[Fix] serviceBus: Add missing check for argument of complete() method
 
 This resolves issue#2756 where some components were receiving errors
 because the complete method did not check for it's arguments and
 optimistically proceeded with the callback execution.
 
-The solution was to add an integrity check for thepassed arguments to
+The solution was to add an integrity check for the passed arguments to
 the complete() method.
 
 ```

diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -11,7 +11,7 @@ Detailed Body Text (if necessary)
 (Involved Commits)
 ```
 
-The scope can be many things. File(s), Components, Sub-Systems. In fact, *any* conceptual unit or scope that the commit applies to.
+The scope can be many things. File(s), Components, Sub-Systems. In fact, *any* conceptual unit or scope that the commit applies to. It can be left away if deemed unnecessary (e.g. on feature branches).
 
 The summary as well as body text lines should be kept below 70–80 characters by manually wrapping the lines. (Github "elipsizes" at 70 chararacters. Often mentioned are 70 or 72)
 
@@ -47,6 +47,37 @@ This is a list of proposed action keywords. It is in no way a definitive list. R
 *WIP*: Work in Progress – Ideally we should not use this. Realistically you will need to make incomplete commits at some point. Use this to warn about the incomplete state your commit causes.
 
 
+## Samples
+```
+Feature|Header: Add header element
+
+Update|header: Move main-nav a bit to the bottom
+Update|service-nav: Add structure/module file
+Fix|Reference: Change reference from all.scss to main.scss in index.html.erb.
+Refactor|Structure: Move styles for main-nav / header into their own files
+Update|Header: Initial strucutre
+Update|Grid: Adjust breakpoints / Import container size configuration
+
+Conflicts:
+source/assets/css/main.sass
+source/index.html.erb
+
+...
+
+```
+
+```
+Fix|serviceBus: Add missing check for argument of complete() method
+
+This resolves issue#2756 where some components were receiving errors
+because the complete method did not check for it's arguments and
+optimistically proceeded with the callback execution.
+
+The solution was to add an integrity check for thepassed arguments to
+the complete() method.
+
+```
+
 ##Other Guidelines
  - [camunda.org Commit Message Conventions](https://github.com/camunda/camunda.org/blob/master/COMMIT_MESSAGES.md) (good stuff!)
  - [angular.js Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) (very similar)

diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -3,15 +3,19 @@ This is a *revamped* proposal for structuring commit messages. It is a set of gu
 
 #Structure
 
-[Action] Scope: Summary
+```
+Action|Scope: Summary
+
+Detailed Body Text (if necessary)
 
 (Involved Commits)
+```
 
-Detailed Body Text (if necessary)
-The scope can be many things. File(s), Components, Sub-Systems. In fact any conceptual unit or scope that the commit applies to.
+The scope can be many things. File(s), Components, Sub-Systems. In fact, *any* conceptual unit or scope that the commit applies to.
 
 The summary as well as body text lines should be kept below 70–80 characters by manually wrapping the lines. (Github "elipsizes" at 70 chararacters. Often mentioned are 70 or 72)
 
+
 ##Action Keywords
 
 This is a list of proposed action keywords. It is in no way a definitive list. Rather, it reflects my personal findings of required keywords I have encountered. Others have been left away for their infrequent use i.e. `Init` or their ambiguity i.e. `Cleanup`. A keyword length of 4-6 letters is recommended where possible.

diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -1,4 +1,4 @@
-#Mini Commit Message Guidelines 
+#Commit Message Guidelines (Shortened) 
 This is a *revamped* proposal for structuring commit messages. It is a set of guidelines evolved from a need to scan, review and navigate commits quickly. They are ment to bring clarity to the commit history while retaining a lot of flexibility.
 
 #Structure

diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -38,7 +38,7 @@ This is a list of proposed action keywords. It is in no way a definitive list. R
 ### Chore
 *Chore*: Includes Cleanup, whitespace, formatting, old dependencies etc. Should not change functionality.
 ### Merge
-*Merge*: Branch merges. Includes a list of merged commits. For a feature branch merges *Feat*/*Fix* or others might be more apropriate.
+*Merge*: Branch merges. Includes a list of merged commits.
 ### WIP
 *WIP*: Work in Progress – Ideally we should not use this. Realistically you will need to make incomplete commits at some point. Use this to warn about the incomplete state your commit causes.
 

diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -36,8 +36,7 @@ This is a list of proposed action keywords. It is in no way a definitive list. R
 ### Refactor
 *Refactor*: Refactoring changes that do not change functionality per se.
 ### Chore
-*Chore*: “ Replaces *Style* | *Format*:
-Includes Cleanup, whitespace, formatting, old dependencies etc. Should not change functionality.
+*Chore*: Includes Cleanup, whitespace, formatting, old dependencies etc. Should not change functionality.
 ### Merge
 *Merge*: Branch merges. Includes a list of merged commits. For a feature branch merges *Feat*/*Fix* or others might be more apropriate.
 ### WIP

diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -22,10 +22,10 @@ This is a list of proposed action keywords. It is in no way a definitive list. R
  - **Chore**
  - **Merge**
  - (*WIP*)
- - ~~Feature / Release~~ – use **Merge** instead 
- - ~~Docs~~ — use **Chore** instead
- - ~~Revert~~ – use **Fix** instead 
- - ~~Test~~ – use **Update** instead
+ - ~~Feature / Release~~ – use *Merge* instead 
+ - ~~Docs~~ — use *Chore* instead
+ - ~~Revert~~ – use *Fix* instead 
+ - ~~Test~~ – use *Update* instead
 
 
 

diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -22,10 +22,10 @@ This is a list of proposed action keywords. It is in no way a definitive list. R
  - **Chore**
  - **Merge**
  - (*WIP*)
-- ~~Feature / Release~~ – use **Merge** instead 
-- ~~Docs~~ — use **Chore** instead
-- ~~Revert~~ – use **Fix** instead 
-- ~~Test~~ – use **Update** instead
+ - ~~Feature / Release~~ – use **Merge** instead 
+ - ~~Docs~~ — use **Chore** instead
+ - ~~Revert~~ – use **Fix** instead 
+ - ~~Test~~ – use **Update** instead
 
 
 

diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -22,8 +22,6 @@ This is a list of proposed action keywords. It is in no way a definitive list. R
  - **Chore**
  - **Merge**
  - (*WIP*)
-
-Removed:
 - ~~Feature / Release~~ – use **Merge** instead 
 - ~~Docs~~ — use **Chore** instead
 - ~~Revert~~ – use **Fix** instead 

diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -1,3 +1,21 @@
+#Mini Commit Message Guidelines 
+This is a *revamped* proposal for structuring commit messages. It is a set of guidelines evolved from a need to scan, review and navigate commits quickly. They are ment to bring clarity to the commit history while retaining a lot of flexibility.
+
+#Structure
+
+[Action] Scope: Summary
+
+(Involved Commits)
+
+Detailed Body Text (if necessary)
+The scope can be many things. File(s), Components, Sub-Systems. In fact any conceptual unit or scope that the commit applies to.
+
+The summary as well as body text lines should be kept below 70–80 characters by manually wrapping the lines. (Github "elipsizes" at 70 chararacters. Often mentioned are 70 or 72)
+
+##Action Keywords
+
+This is a list of proposed action keywords. It is in no way a definitive list. Rather, it reflects my personal findings of required keywords I have encountered. Others have been left away for their infrequent use i.e. `Init` or their ambiguity i.e. `Cleanup`. A keyword length of 4-6 letters is recommended where possible.
+
  - **Update**
  - **Fix**
  - **Refactor**

diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -1,3 +1,33 @@
+ - **Update**
+ - **Fix**
+ - **Refactor**
+ - **Chore**
+ - **Merge**
+ - (*WIP*)
+
+Removed:
+- ~~Feature / Release~~ – use **Merge** instead 
+- ~~Docs~~ — use **Chore** instead
+- ~~Revert~~ – use **Fix** instead 
+- ~~Test~~ – use **Update** instead
+
+
+
+### Update
+*Update*: A generic update that involves changes and does not fit any other category.
+### Fix
+*Fix*: Code fixes and bug fixes
+### Refactor
+*Refactor*: Refactoring changes that do not change functionality per se.
+### Chore
+*Chore*: “ Replaces *Style* | *Format*:
+Includes Cleanup, whitespace, formatting, old dependencies etc. Should not change functionality.
+### Merge
+*Merge*: Branch merges. Includes a list of merged commits. For a feature branch merges *Feat*/*Fix* or others might be more apropriate.
+### WIP
+*WIP*: Work in Progress – Ideally we should not use this. Realistically you will need to make incomplete commits at some point. Use this to warn about the incomplete state your commit causes.
+
+
 ##Other Guidelines
  - [camunda.org Commit Message Conventions](https://github.com/camunda/camunda.org/blob/master/COMMIT_MESSAGES.md) (good stuff!)
  - [angular.js Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) (very similar)

diff --git a/mini_commit_guidelines.md b/mini_commit_guidelines.md
@@ -0,0 +1,28 @@
+##Other Guidelines
+ - [camunda.org Commit Message Conventions](https://github.com/camunda/camunda.org/blob/master/COMMIT_MESSAGES.md) (good stuff!)
+ - [angular.js Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) (very similar)
+ - Notably also Tim Pope's ["A Note About Git Commit Messages"](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+Personally I do not agree with the 50 chars summary, yet with the rest I can wholeheartedly agree. Especially the part about the imperative. The commit message should convey what it **does** (or what it intends to do).
+```
+Capitalized, short (50 chars or less) summary
+
+More detailed explanatory text, if necessary.  Wrap it to about 72
+characters or so.  In some contexts, the first line is treated as the
+subject of an email and the rest of the text as the body.  The blank
+line separating the summary from the body is critical (unless you omit
+the body entirely); tools like rebase can get confused if you run the
+two together.
+
+Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
+or "Fixes bug."  This convention matches up with commit messages generated
+by commands like git merge and git revert.
+
+Further paragraphs come after blank lines.
+
+- Bullet points are okay, too
+
+- Typically a hyphen or asterisk is used for the bullet, followed by a
+  single space, with blank lines in between, but conventions vary here
+
+- Use a hanging indent
+```
No results found