Skip to content

Commit 0c13d7d

Browse files
authored
Fix README (#2)
This commit fixes minor glitches in the README and adds a badge for the build status.
1 parent 0d2e7b9 commit 0c13d7d

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

Diff for: README.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# opinionated-commit-message
2-
Opinionated-commit-message is a Github Action which checks commit messages according to an opinioned style.
2+
3+
![build-and-test](
4+
https://github.com/mristin/opinionated-commit-message/workflows/build-and-test/badge.svg?branch=master
5+
)
6+
7+
Opinionated-commit-message is a Github Action which checks commit messages
8+
according to an opinionated style.
39

410
The style was inspired by https://chris.beams.io/posts/git-commit/:
511

@@ -14,15 +20,18 @@ The style was inspired by https://chris.beams.io/posts/git-commit/:
1420
## Prior Art
1521

1622
There exist a good action to check commit messages, commit-message-checker
17-
(https://github.com/GsActions/commit-message-checker). However, it is limited to regular expressions which makes more
18-
complex checks (such as imperative mood) hard or impossible to implement.
23+
(https://github.com/GsActions/commit-message-checker). However, it is limited
24+
to regular expressions which makes more complex checks (such as imperative mood)
25+
hard or impossible to implement.
1926

20-
I based my implementation heavily on commit-message-checker and would like to thank the author for the great work!
27+
I based my implementation heavily on commit-message-checker and would like to
28+
thank the author for the great work!
2129

2230
## Example Workflow
2331

24-
You can set up a Github workflow to automatically check messages. Put the following file in
25-
`.github/workflows/check-commit-message.yml` and the Github should pick it and set it up.
32+
You can set up a Github workflow to automatically check messages.
33+
Put the following file in `.github/workflows/check-commit-message.yml` and
34+
Github should pick it and set it up.
2635

2736
```yml
2837
name: 'Check commit message style'
@@ -50,9 +59,9 @@ jobs:
5059
## Contributing
5160
5261
If you would like to report bugs or request a feature, please create
53-
a (new issue)[https://github.com/mristin/opinionated-commit-message/issues/new].
62+
a [new issue](https://github.com/mristin/opinionated-commit-message/issues/new).
5463
55-
Please see (CONTRIBUTING.md)[https://github.com/mristin/opinionated-commit-message/blob/master/CONTRIBUTING.md] if you
64+
Please see [CONTRIBUTING.md](CONTRIBUTING.md) if you
5665
would like to contribute to the code.
5766
5867
## License

0 commit comments

Comments
 (0)