Skip to content
This repository
Browse code

MINOR Updated commit docs

  • Loading branch information...
commit 464504a9bf489fd6bfa2fbee0767764823910b10 1 parent e2c1deb
Ingo Schommer authored June 20, 2012

Showing 1 changed file with 18 additions and 12 deletions. Show diff stats Hide diff stats

  1. 30  docs/en/misc/contributing.md
30  docs/en/misc/contributing.md
Source Rendered
@@ -69,25 +69,28 @@ If you want to learn more about git, please have a look at the [free online git
69 69
 
70 70
 ### Commit Messages
71 71
 
72  
-We try to maintain a consistent record of descriptive commit messages. As we automatically generate changelogs from them, we need a way to categorize and filter. Please prefix **all** commit messages with one of the following tags: 
  72
+We try to maintain a consistent record of descriptive commit messages. 
  73
+Most importantly: Keep the first line short, and add more detail below.
  74
+This ensures commits are easy to browse, and look nice on github.com
  75
+(more info about [proper git commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)).
  76
+
  77
+As we automatically generate [changelogs](http://doc.silverstripe.org/sapphire/en/trunk/changelogs/) from them, we need a way to categorize and filter. 
  78
+Please prefix **all** commit messages with one of the following tags: 
73 79
 
74 80
 * `API CHANGE`: You've added or modified the functions available to developers writing custom PHP.
75 81
 * `ENHANCEMENT`: You've added something to the user-visible aspects of SilverStripe.
76 82
 * `BUGFIX`: You've fixed something that was broken.
77  
-* `MINOR` Mark things that are so trivial they're not even worth telling users about; specifically, to prevent adding
78  
-clutter to our automatically generated changelogs. MINOR is not used to mark a minor bugfix or feature, see above.
79  
-Some examples:
80  
-	* a subsequent commit to a bugfix/feature that you committed earlier that day
81  
-	* adding unit tests (that are more interesting to developers of SilverStripe than users of it)
82  
-	* subversion/codebase plumbing (changing externals, blocking revisions, moving files around, etc)
83  
-	* In summary: if it's worth including in the changelog, it's not `MINOR`.
  83
+* `MINOR` Mark things that are so trivial they're not worth attention by most developers; 
  84
+   specifically, to prevent adding clutter to our automatically generated changelogs. 
  85
+   For example, adding unit tests or documentation would be considered "minor".
  86
+	 Same goes for version control plumbing like merges, file renames or reverts.
84 87
 
85 88
 Further guidelines:
86 89
 
87 90
 * Each commit should form a logical unit - if you fix two unrelated bugs, commit each one separately
88 91
 * If you are fixing a ticket from our [bugtracker](http://open.silverstripe.com), please append `(fixes #<ticketnumber>)`
89  
-* If your change is related to another changeset, reference it with `r<revisionnumber>`. 
90  
-* Please mention the changed classes and methods in your comment - the message should be understandable on its own without browsing any sourcecode
  92
+* If your change is related to another commit, reference it with its abbreviated commit hash. 
  93
+* Mention important changed classes and methods in the commit summary.
91 94
 
92 95
 Example: Bad commit message
93 96
 
@@ -96,8 +99,11 @@ Example: Bad commit message
96 99
 
97 100
 Example: Good commit message
98 101
 
99  
-	ENHANCEMENT Added prepValueForDB() which is called on DBField->writeToManipulation() to ensure formatting of value before insertion to DB on a per-DBField type basis (see #1234)
100  
-	MINOR Added documentation for DBField->writeToManipulation() (see r55555)
  102
+	ENHANCEMENT Formatting through prepValueForDB() 
  103
+
  104
+	Added prepValueForDB() which is called on DBField->writeToManipulation() 
  105
+	to ensure formatting of value before insertion to DB on a per-DBField type basis (fixes #1234).
  106
+	Added documentation for DBField->writeToManipulation() (related to a4bd42fd).
101 107
 	
102 108
 <div class="hint" markdown="1">
103 109
 Note: By supplying code in patches, tickets and pull requests, 

0 notes on commit 464504a

Please sign in to comment.
Something went wrong with that request. Please try again.