Skip to content

Commit 7aebaa2

Browse files
committed
chore(tutorials): readme gifs and custom commit tutorial
1 parent c0e99f4 commit 7aebaa2

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,19 @@ Keeping a commit policy may sound like an easy thing to do, but in reality we bo
2626

2727
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?
2828

29+
## Screenshots
30+
31+
<div style="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+
2942
## Installation
3043

3144
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:
@@ -92,11 +105,23 @@ convention: symphony # [Tag] commit message
92105
convention: none # Commit message
93106
```
94107
108+
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+
95118
Supported conventions available:
96119
97-
- angular/karma
120+
- angular
121+
- karma
98122
- changelog
99123
- symphony
124+
- a custom one that you may invent ;)
100125
101126
## Troubleshooting
102127
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

Comments
 (0)