Skip to content

Commit 39d2c22

Browse files
committed
docs(cli): Add screenshot of add-commit
1 parent 4b79fdc commit 39d2c22

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@ npm install -g commitizen
1111
#### Using the command line tool
1212
Now, simply use `git cz` instead of `git commit` when committing.
1313

14-
When you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers. If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.
14+
When you're working in a Commitizen friendly repository, you'll be prompted to fill in any required fields and your commit messages will be formatted according to the the standards defined by project maintainers.
15+
16+
[![Add and commit with Commitizen](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)
17+
18+
If you're not working in a Commitizen friendly repository, then `git cz` will work just the same as `git commit`.
1519

1620
### Commitizen for project maintainers
1721
As a project maintainer, making your repo Commitizen friendly allows you to select pre-existing commit message conventions or to create your own custom commit message convention. When a contributor to your repo uses Commitizen, they will be prompted for the correct fields at commit time.

meta/screenshots/add-commit.png

63 KB
Loading

0 commit comments

Comments
 (0)