Skip to content
This repository
Browse code

API New commit tagging rules in contrib guidelines

  • Loading branch information...
commit 2b31f4aa155af5bd72a2f9bd3c7c9dbe003b55e0 1 parent 218037b
Ingo Schommer authored June 27, 2012

Showing 1 changed file with 11 additions and 9 deletions. Show diff stats Hide diff stats

  1. 20  docs/en/misc/contributing.md
20  docs/en/misc/contributing.md
Source Rendered
@@ -75,15 +75,17 @@ This ensures commits are easy to browse, and look nice on github.com
75 75
 (more info about [proper git commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)).
76 76
 
77 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: 
79  
-
80  
-* `API CHANGE`: You've added or modified the functions available to developers writing custom PHP.
81  
-* `ENHANCEMENT`: You've added something to the user-visible aspects of SilverStripe.
82  
-* `BUGFIX`: You've fixed something that was broken.
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.
  78
+Please prefix **noteworthy** commit messages with one of the following tags: 
  79
+
  80
+* `NEW`: New feature or major enhancement (both for users and developers)
  81
+* `API`: Addition of a new API, or modification/removal/deprecation of an existing API.
  82
+  Includes any change developers should be aware of when upgrading.
  83
+* `BUG`: Bugfix or minor enhancement on something developers or users are likely to encounter.
  84
+
  85
+All other commits should not be tagged if they are so trivial that most developers
  86
+can ignore them during upgrades or when reviewing changes to the codebase.
  87
+For example, adding unit tests or documentation would not be considered "noteworthy".
  88
+Same goes for version control plumbing like merges, file renames or reverts.
87 89
 
88 90
 Further guidelines:
89 91
 

0 notes on commit 2b31f4a

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