From e3b8d9544e2e302026a6504a35de8a1acf8eb1a8 Mon Sep 17 00:00:00 2001 From: ckarlof Date: Thu, 15 May 2014 11:54:33 -0700 Subject: [PATCH] Update CONTRIBUTING.md with git commit guidelines Avoid the problem in mozilla/fxa-content-server#1123. --- packages/fxa-content-server/CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/packages/fxa-content-server/CONTRIBUTING.md b/packages/fxa-content-server/CONTRIBUTING.md index 20dfbfc762..967956ef41 100644 --- a/packages/fxa-content-server/CONTRIBUTING.md +++ b/packages/fxa-content-server/CONTRIBUTING.md @@ -1,5 +1,20 @@ # Contribution Guidelines for the Firefox Accounts Content Server +## Git Commit Guidelines + +We loosely follow the [Angular commit guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#type) of `(): ` where `type` must be one of: + +* **feat**: A new feature +* **fix**: A bug fix +* **docs**: Documentation only changes +* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing + semi-colons, etc) +* **refactor**: A code change that neither fixes a bug or adds a feature +* **perf**: A code change that improves performance +* **test**: Adding missing tests +* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation + generation + ## Grunt Commands [Grunt](http://gruntjs.com/) is used to run common tasks to build, test, and run local servers.