Skip to content

Commit 685998a

Browse files
committed
docs(readme): add Commitizen section with installation instructions
1 parent 398fc74 commit 685998a

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,35 @@ This config will allows you to edit the commit message after picking from lazyco
223223
```
224224

225225

226+
227+
### Commitizen
228+
229+
First, install the Commitizen plugin:
230+
231+
```bash
232+
pip install cz-lazycommit
233+
# or if you are using Arch Linux:
234+
uv tool install commitizen --with cz-lazycommit
235+
```
236+
237+
Then use the plugin with the following command:
238+
239+
```bash
240+
git cz --name cz_lazycommit commit
241+
```
242+
243+
If you are using Commitizen with Lazygit, you can add this custom command:
244+
245+
```yaml
246+
- key: "C"
247+
command: "git cz --name cz_lazycommit commit"
248+
description: "Commit with Commitizen"
249+
context: "files"
250+
loadingText: "Opening Commitizen commit tool"
251+
output: terminal
252+
```
253+
254+
226255
## Troubleshooting
227256

228257
- "No staged changes to commit." — run `git add` first.

0 commit comments

Comments
 (0)