Skip to content

Commit

Permalink
docs: introduce conventional-commits (#1234)
Browse files Browse the repository at this point in the history
  • Loading branch information
prusnak authored Sep 15, 2020
1 parent 65e2011 commit 60b7638
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
29 changes: 29 additions & 0 deletions COMMITS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Commits

Using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) is strongly recommended and might be enforced in future.

### Examples

```
docs: correct spelling of CHANGELOG
feat: allow provided config object to extend other configs
feat(lang): added polish language
```

### Git hook

Use this git hook to auto-check your commit messages. Save the following snippet into `.git/hooks/commit-msg`

```
#!/bin/sh
if ! grep -qE "^(build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert)(\((common|core|crypto|legacy|python|storage|tools|vendor)\))?: " "$1" ; then
echo "Conventional Commits validation failed"
exit 1
fi
```

If you want to bypass commit-msg hook check, you may always use

```
git commit -m "foobar" --no-verify
```
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@

See [CONTRIBUTING.md](docs/misc/contributing.md).

Using [Conventional Commits](COMMITS.md) is strongly recommended and might be enforced in future.

Also please have a look at the docs, either in the `docs` folder or at [docs.trezor.io](https://docs.trezor.io) before contributing. The [misc](docs/misc/index.md) chapter should be read in particular because it contains some useful assorted knowledge.

## Security vulnerability disclosure
Expand Down

0 comments on commit 60b7638

Please sign in to comment.