You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-1Lines changed: 26 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,19 @@ Keeping a commit policy may sound like an easy thing to do, but in reality we bo
26
26
27
27
Sometimes we, the developers, go _full-loco_ while programming and make mistakes when commiting. That's fine, everyone makes mistakes. But, what if those mistakes could be avoided?
28
28
29
+
## Screenshots
30
+
31
+
<divstyle="margin-right:auto;margin-left:auto;">
32
+
<img src="assets/commit.gif"/>
33
+
<img src="assets/--tudo.gif"/>
34
+
<img src="assets/--co-author.gif"/>
35
+
<img src="assets/--debug.gif"/>
36
+
<img src="assets/--no-file.gif"/>
37
+
<img src="assets/--convention.gif"/>
38
+
</div>
39
+
40
+
41
+
29
42
## Installation
30
43
31
44
In order to install one of our older versions, check our [previous releases](PREVIOUS_VERSIONS). To install the latest (pip) version, just follow the commands below:
In case that you or your organization does already have a commit convention that is not listed above, you can configure it in the commiter.yml file as following:
109
+
110
+
```yaml
111
+
convention: custom
112
+
# considering a commit message like '{add} (stuff) ~> in file foo.br'
113
+
commit_pattern: '{tag} (context) ~> message'
114
+
# tag, message and context are reserved words that will be replaced in your commit message
115
+
context: true# this is a must have field! If your pattern doesn't have one, assign false to it
116
+
```
117
+
95
118
Supported conventions available:
96
119
97
-
- angular/karma
120
+
- angular
121
+
- karma
98
122
- changelog
99
123
- symphony
124
+
- a custom one that you may invent ;)
100
125
101
126
## Troubleshooting
102
127
If after you've installed commit-helper the `commit` or `commit-helper` commands are not usable at the command line, check if `$HOME/.local/bin` is on your PATH. If not, add it on your .bashrc file by running:
0 commit comments