Skip to content

Commit

Permalink
API New commit tagging rules in contrib guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
chillu committed Jun 26, 2012
1 parent 218037b commit 2b31f4a
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/en/misc/contributing.md
Expand Up @@ -75,15 +75,17 @@ This ensures commits are easy to browse, and look nice on github.com
(more info about [proper git commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)). (more info about [proper git commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)).


As we automatically generate [changelogs](http://doc.silverstripe.org/sapphire/en/trunk/changelogs/) from them, we need a way to categorize and filter. As we automatically generate [changelogs](http://doc.silverstripe.org/sapphire/en/trunk/changelogs/) from them, we need a way to categorize and filter.
Please prefix **all** commit messages with one of the following tags: Please prefix **noteworthy** commit messages with one of the following tags:


* `API CHANGE`: You've added or modified the functions available to developers writing custom PHP. * `NEW`: New feature or major enhancement (both for users and developers)
* `ENHANCEMENT`: You've added something to the user-visible aspects of SilverStripe. * `API`: Addition of a new API, or modification/removal/deprecation of an existing API.
* `BUGFIX`: You've fixed something that was broken. Includes any change developers should be aware of when upgrading.
* `MINOR` Mark things that are so trivial they're not worth attention by most developers; * `BUG`: Bugfix or minor enhancement on something developers or users are likely to encounter.
specifically, to prevent adding clutter to our automatically generated changelogs.
For example, adding unit tests or documentation would be considered "minor". All other commits should not be tagged if they are so trivial that most developers
Same goes for version control plumbing like merges, file renames or reverts. can ignore them during upgrades or when reviewing changes to the codebase.
For example, adding unit tests or documentation would not be considered "noteworthy".
Same goes for version control plumbing like merges, file renames or reverts.


Further guidelines: Further guidelines:


Expand Down

0 comments on commit 2b31f4a

Please sign in to comment.