Skip to content

Commit

Permalink
Updated the README file to reflect the new commit conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
wakaleo committed Dec 23, 2014
1 parent 80ee2cf commit 71d6c5a
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ updated automatically for every new release, and is generated by the build proce

## Commit message conventions
Commit messages are used to generate the release notes for each release. To do this, we loosely follow the AngularJS commit conventions: for commit messages to appear in the release notes, the title line needs to respect the following format:
```
<type>: <message>
```

where <type> is one of the following:
- feat: A new feature
Expand All @@ -53,10 +55,7 @@ where <type> is one of the following:
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

## Useful links

COMING SOON

Starting from version 1.0.24, any commits without one of these prefixes will not appear in the release notes.

## Licensing

Expand Down

0 comments on commit 71d6c5a

Please sign in to comment.