Skip to content

Latest commit

 

History

History
116 lines (78 loc) · 2.4 KB

COMMITS.md

File metadata and controls

116 lines (78 loc) · 2.4 KB
Raw

Commits

We use conventional commits in order to automatically define versions and create a changelog. THis will help us keep a better overview of what has changed over time or was added in the last version.

Writing commits

All commits are linted, so you will not be able to commit until your message follows our rules. Please read conventional commits to get a better understanding on why this is helpful and how this works. You can also look at Semantic Versioning if you are interested in more detail about versioning.

Good commit messages

A good commit message is important for us for several reasons

  1. Make use of automatic Semantic Versions
  2. Generate a change changelog
  3. Give contributors a chance to easily understand what has been done

In general the following rule applies:

Keep messages short and concise.

Examples for different types of messages

Chore

Chore commits should be used in the following cases:

  1. Update NPM packages
  2. Update NPM scripts
  3. Update files outside the Source folder
  4. Update configuration files

Updating npm packages:

chore: update packages
## OR
chore(npm): update packages

Updating config files:

chore: adjust xo.config
## OR
chore(xo): update configuration
## OR
chore(hooks): add pre-commit hook

Docs

Docs commits should be used in the following cases:

  1. Update documentation files
  2. Update comments or doc-blocks in Source files

Update documentation:

docs: typo in readme
## OR
docs(button): api changes

Test

Test commits should be used in the following cases:

  1. Update test files

Update test:

test: add test for signin
## OR
test(signin): added new test case

Fix

Fix commits should only contain bug-fixes.

Fix bug:

fix: checkbox state was inverted
## OR
fix(checkbox): checked state was inverted
## OR
fix(checkbox): state was inverted

checking a checkbox was wrong when the outside state changed

fixes: #123

Feat

Feature commit should be used for every feature-story. Each story is on feature.

Add feature:

feat(signup): add signup screen
#OR
feat(signup): tighten password rules

BREAKING CHANGE Users might need to update their password