Skip to content

Commit a666ce8

Browse files
marioneblLinusU
authored andcommitted
docs: add contribution guide (#305)
* Add partial conttribution guide * Document rough coding rules * Document commit rules * Document semantic-release Fixes #303
1 parent 25d2ddb commit a666ce8

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contribution guide
2+
3+
## Developing commitizen
4+
5+
You consider contributing changes to commitizen – thank you!
6+
Please consider these guidelines when filing a pull request:
7+
8+
* Commits follow the Angular commit convention
9+
* JavaScript is written using ES2015 features
10+
* 4 spaces indentation
11+
* Features and bug fixes should be covered by test cases
12+
13+
## Creating releases
14+
15+
commitizen uses [semantic-release](https://github.com/semantic-release/semantic-release)
16+
to release new versions automatically.
17+
18+
* Commits of type `fix` will trigger bugfix releases, think `0.0.1`
19+
* Commits of type `feat` will trigger feature releases, think `0.1.0`
20+
* Commits with `BREAKING CHANGE` in body or footer will trigger breakgin releases, think `1.0.0`
21+
22+
All other commit types wil trigger no new release.

0 commit comments

Comments
 (0)