actions/action-conventional-commits
actions/action-conventional-commits
1
0
Fork 0
mirror of https://github.com/webiny/action-conventional-commits.git synced 2024-09-20 04:35:06 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: update README

Browse source
This commit is contained in:
Adrian Smijulj 2020-06-11 10:01:04 +02:00
parent 9ff4d3f939
commit 3e57058549
2 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -2,6 +2,8 @@
A simple GitHub action that makes sure all commit messages are following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification. If not, workflow will fail. A simple GitHub action that makes sure all commit messages are following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification. If not, workflow will fail.
![Screenshot](/docs/screenshot.png)
Note that, typically, you would make this check on a pre-commit hook (for example, using something like [Commitlint](https://commitlint.js.org/)), but those can easily be skipped, hence this GitHub action. Note that, typically, you would make this check on a pre-commit hook (for example, using something like [Commitlint](https://commitlint.js.org/)), but those can easily be skipped, hence this GitHub action.
### Usage ### Usage

BIN
docs/screenshot.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 117 KiB