Skip to content
This repository was archived by the owner on Dec 1, 2018. It is now read-only.

Commit 0a82c71

Browse files
committed
docs: Add badges. Add contribute section
1 parent 29426b3 commit 0a82c71

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@
88
<hr>
99

1010
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
11+
[![Build Status](https://travis-ci.org/dixeed/angularjs-scripts.svg?branch=master)](https://travis-ci.org/dixeed/angularjs-scripts)
12+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
13+
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
14+
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://opensource.org/licenses/MIT)
15+
1116

1217
## Disclaimer
1318
**This project is made to be used in Dixeed's projects thus its configuration may not suit every needs.**
@@ -16,12 +21,19 @@
1621
The projects using this script should meet some requirements in order for the scripts to work:
1722

1823
1. Have an `app` folder containing the project source code.
19-
2. Node version >= 4.x
24+
2. Node version >= 6.x
2025

2126
The script will build the project into a `dist` folder.
2227

2328
**It has only been tested with node 6.11.2 so far**
2429

30+
## Contributing
31+
This project uses [semantic-release](https://github.com/semantic-release/semantic-release) to automatically handle semver bumps based on the commits messages.
32+
33+
To simplify commits messages redaction you can use `npm run cm` instead of `git commit`. To use that command make sure to `git add` your changes before.
34+
35+
This repo is configured to forbid commit messages that do not follow the [Angular conventional changelog commit message format](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit).
36+
2537
## Inspiration
2638
This project is inspired by several other projects:
2739
* Create React App: https://github.com/facebookincubator/create-react-app

0 commit comments

Comments
 (0)