Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add commit message convention and coding rules #32

Merged
merged 2 commits into from
Oct 13, 2021
Merged

Add commit message convention and coding rules #32

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca47721
docs: add commit message convention and coding rules
oklas Oct 12, 2021
60bad87
docs: lightly softify commit convention requirements
oklas Oct 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,22 @@ To work on a new feature or a fix please create a new branch:
$ git checkout -b feature-xyz # or fix-xyz
```

### Coding rules

- Unit-testing: all features or bug fixes must be tested by specs
- Documentation: all public API methods must be documented

### Commit message convention

We use a commit convention, inspired by [angular commit message format](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format)
with ticket number at the end of summary:

```
<type>(<scope>): <short summary> #<issue nuber>
```
Summary in present tense. Not capitalized. No period at the end.
The <type> and <summary> fields are mandatory, the (<scope>) and #<number> field is optional.

### Run the tests before committing

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