You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16Lines changed: 16 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -81,6 +81,22 @@ To work on a new feature or a fix please create a new branch:
81
81
$ git checkout -b feature-xyz # or fix-xyz
82
82
```
83
83
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
+
84
100
### Run the tests before committing
85
101
86
102
Please always make sure your code is passing linter and tests **before
0 commit comments