arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-11-23 07:58:09 +00:00
Code Issues Releases Wiki Activity

docs: introduce conventional-commits (#1234)

Browse Source
This commit is contained in:
Pavol Rusnak 2020-09-15 16:11:39 +02:00 committed by GitHub
parent 65e20119ea
commit 60b7638882
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
COMMITS.md Normal file
View File

@ -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
README.md
View File

@ -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