From 699afac37fd3f50f5ef4d3ca63383be10d1a18f0 Mon Sep 17 00:00:00 2001 From: shipengqi Date: Tue, 19 Mar 2024 10:05:31 +0800 Subject: [PATCH 1/4] docs(usage): update help information --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 129ef9c..dc4561a 100644 --- a/README.md +++ b/README.md @@ -20,16 +20,18 @@ Usage: commitizen commitizen [command] -Available Commands: +Available Commands: init Install this tool to git-core as git-cz. version Print the CLI version information. help Help about any command Flags: - -s, --signoff add a Signed-off-by trailer by the committer at the end of the commit log message. - -a, --add tell the command to automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected. - --dry-run you can use the --dry-run flag to preview the message that would be committed, without really submitting it. - -h, --help help for commitizen + -a, --add tell the command to automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected. + -s, --signoff add a Signed-off-by trailer by the committer at the end of the commit log message. + --dry-run you can use the --dry-run flag to preview the message that would be committed, without really submitting it. + -t, --template string template name to use when multiple templates exist. + -d, --default use the default template, same as '--template default'. '--default' has a higher priority than '--template'. + -h, --help help for commitizen Use "commitizen [command] --help" for more information about a command. ``` From ddc68e1627c2f6f024c9873600b59d9779e2591d Mon Sep 17 00:00:00 2001 From: shipengqi Date: Tue, 19 Mar 2024 10:19:33 +0800 Subject: [PATCH 2/4] docs(usage): update help information --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dc4561a..8f1205b 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Flags: -s, --signoff add a Signed-off-by trailer by the committer at the end of the commit log message. --dry-run you can use the --dry-run flag to preview the message that would be committed, without really submitting it. -t, --template string template name to use when multiple templates exist. - -d, --default use the default template, same as '--template default'. '--default' has a higher priority than '--template'. + -d, --default use the default template, '--default' has a higher priority than '--template'. -h, --help help for commitizen Use "commitizen [command] --help" for more information about a command. From 2ba815f426424fd2a227880611afec0c1481ff60 Mon Sep 17 00:00:00 2001 From: shipengqi Date: Tue, 19 Mar 2024 16:45:56 +0800 Subject: [PATCH 3/4] docs(usage): add features in the readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f1205b..2a80e94 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,17 @@ Command line utility to standardize git commit messages, golang version. Forked from [commitizen-go](https://github.com/lintingzhen/commitizen-go). -The [survey](https://github.com/AlecAivazis/survey) project is no longer maintained. Therefore, this project uses [bubbletea](https://github.com/charmbracelet/bubbletea) instead. +Fixes some issues of commitizen-go and supports more new features. ![demo](https://github.com/shipengqi/illustrations/blob/ebe8786a60c6467edb3122723d74d22f639fb216/commitizen/demo.gif?raw=true) +## Features + +- Multi-template support +- Default template support +- Better unit tests. +- Use [bubbletea](https://github.com/charmbracelet/bubbletea) instead of [survey](https://github.com/AlecAivazis/survey) ([survey](https://github.com/AlecAivazis/survey) is no longer maintained). + ## Getting Started ``` From b1ee399382a25538f66f7b197d90bd24a11a9f13 Mon Sep 17 00:00:00 2001 From: shipengqi Date: Tue, 19 Mar 2024 16:49:30 +0800 Subject: [PATCH 4/4] docs(usage): add more features --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2a80e94..de4101e 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,10 @@ Fixes some issues of commitizen-go and supports more new features. ## Features - Multi-template support -- Default template support -- Better unit tests. +- Dry-run support +- Signed-off support - Use [bubbletea](https://github.com/charmbracelet/bubbletea) instead of [survey](https://github.com/AlecAivazis/survey) ([survey](https://github.com/AlecAivazis/survey) is no longer maintained). +- Better unit tests. ## Getting Started