From 3cced99b961f905f7f82a44045050a0865d91fd4 Mon Sep 17 00:00:00 2001 From: "Eddie Monge Jr." Date: Tue, 12 Nov 2013 12:10:42 -0800 Subject: [PATCH] docs(contributing): add git commit message guidelines Update with brief message about what goes in the commit message --- contributing.md | 62 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 58 insertions(+), 4 deletions(-) diff --git a/contributing.md b/contributing.md index 7604b9ad8..d676ea56f 100644 --- a/contributing.md +++ b/contributing.md @@ -1,11 +1,65 @@ +# Contributing + See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contributing.md) Additionally for this generator: -When submitting an issue, please follow the [guidelines](https://github.com/yeoman/yeoman/blob/master/contributing.md#issue-submission). Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue. +* When submitting an issue, please follow the [guidelines](https://github.com/yeoman/yeoman/blob/master/contributing.md#issue-submission). Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue. +* When submitting a PR, make sure that the commit messages match the [AngularJS conventions][commit-message-format] (see below). +* When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix. +* When submitting a new feature, add tests that cover the feature. + +## Git Commit Guidelines + +These rules are adopted from the AngularJS project. + +### Commit Message Format +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +``` +(): + + + +