Skip to content

docs(multi-templates): update images for multiple templates #36

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.

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 1 commit into from
Mar 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# commitizen

[![test](https://github.com/shipengqi/commitizen/actions/workflows/e2e.yaml/badge.svg)](https://github.com/shipengqi/commitizen/actions/workflows/e2e.yaml)
[![Go Report Card](https://goreportcard.com/badge/github.com/shipengqi/commitizen)](https://goreportcard.com/report/github.com/shipengqi/commitizen)
[![release](https://img.shields.io/github/release/shipengqi/commitizen.svg)](https://github.com/shipengqi/commitizen/releases)
[![license](https://img.shields.io/github/license/shipengqi/commitizen)](https://github.com/shipengqi/commitizen/blob/main/LICENSE)
Expand All @@ -8,7 +9,7 @@ Command line utility to standardize git commit messages, golang version. Forked

The [survey](https://github.com/AlecAivazis/survey) project is no longer maintained. Therefore, this project uses [bubbletea](https://github.com/charmbracelet/bubbletea) instead.

![demo](docs/images/demo.gif)
![demo](https://github.com/shipengqi/illustrations/blob/ebe8786a60c6467edb3122723d74d22f639fb216/commitizen/demo.gif?raw=true)

## Getting Started

Expand Down Expand Up @@ -66,7 +67,7 @@ You must have a working Go environment:
```
$ git clone https://github.com/shipengqi/commitizen.git
$ cd commitizen
$ make && ./commitizen init
$ make && ./_output/$(GOOS)/$(GOARCH)/bin/commitizen init
```

## Configuration
Expand Down Expand Up @@ -147,4 +148,4 @@ items:
format: "{{.type}}{{with .scope}}({{.}}){{end}}: {{.subject}}{{with .body}}\n\n{{.}}{{end}}{{with .footer}}\n\n{{.}}{{end}}"`
```

![multiple-templates](docs/images/multiple-templates.png)
![multiple-templates](https://github.com/shipengqi/illustrations/blob/ebe8786a60c6467edb3122723d74d22f639fb216/commitizen/multiple-templates.png?raw=true)
Binary file removed docs/images/demo.gif
Binary file not shown.
Binary file removed docs/images/multiple-templates.png
Binary file not shown.