1
1
# 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.
3
9
4
10
The style was inspired by https://chris.beams.io/posts/git-commit/ :
5
11
@@ -14,15 +20,18 @@ The style was inspired by https://chris.beams.io/posts/git-commit/:
14
20
## Prior Art
15
21
16
22
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.
19
26
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!
21
29
22
30
## Example Workflow
23
31
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.
26
35
27
36
``` yml
28
37
name : ' Check commit message style'
50
59
## Contributing
51
60
52
61
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) .
54
63
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
56
65
would like to contribute to the code.
57
66
58
67
## License
0 commit comments