Skip to content

docs(usage): update features and help information #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 20, 2024
Merged

docs(usage): update features and help information #42

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
699afac
docs(usage): update help information
shipengqi Mar 19, 2024
ddc68e1
docs(usage): update help information
shipengqi Mar 19, 2024
2ba815f
docs(usage): add features in the readme
shipengqi Mar 19, 2024
b1ee399
docs(usage): add more features
shipengqi Mar 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,18 @@

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
- 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

```
Expand All @@ -20,16 +28,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, '--default' has a higher priority than '--template'.
-h, --help help for commitizen

Use "commitizen [command] --help" for more information about a command.
```
Expand Down