Skip to content

Commit 0bb1b23

Browse files
authored
Merge pull request #32 from oklas/contrib
Add commit message convention and coding rules
2 parents de41dc7 + 60bad87 commit 0bb1b23

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,22 @@ To work on a new feature or a fix please create a new branch:
8181
$ git checkout -b feature-xyz # or fix-xyz
8282
```
8383

84+
### Coding rules
85+
86+
- Unit-testing: all features or bug fixes must be tested by specs
87+
- Documentation: all public API methods must be documented
88+
89+
### Commit message convention
90+
91+
We use a commit convention, inspired by [angular commit message format](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format)
92+
with ticket number at the end of summary:
93+
94+
```
95+
<type>(<scope>): <short summary> #<issue nuber>
96+
```
97+
Summary in present tense. Not capitalized. No period at the end.
98+
The <type> and <summary> fields are mandatory, the (<scope>) and #<number> field is optional.
99+
84100
### Run the tests before committing
85101

86102
Please always make sure your code is passing linter and tests **before

0 commit comments

Comments
 (0)