-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
manpage: | ||
@echo "Generating manpage from '/share/man/git-cc.1.md'" | ||
@$$(go env GOPATH)/bin/md2roff -date "$(date +%Y-%m-%d)" -manual "git-cc" share/man/git-cc.1.md | ||
@gzip -9 share/man/git-cc.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
|
||
git-cc(1) -- conventional commits based commit message generator | ||
================================================================ | ||
|
||
## Synopsis | ||
|
||
`git cc [--version]` | ||
|
||
## Description | ||
|
||
git-cc is interactive git sub-command that will help you craft beautify and informative commit message that adhere to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. | ||
|
||
## Examples | ||
|
||
|
||
|
||
## Configuration | ||
|
||
`git-cc` supports a simple yaml based configuration to customize the prompt behavoir on a repo basis. Simply add a `.git-cc.yaml` into the root of your repository. See [.git-cc.example.yaml](.git-cc.example.yaml) | ||
|
||
```yaml | ||
# .git-cc.yaml | ||
use_defaults: true | ||
custom_commit_types: [ | ||
build, | ||
chore, | ||
ci, | ||
docs, | ||
style, | ||
refactor, | ||
perf, | ||
test | ||
] | ||
``` | ||
|
||
| property | options | | ||
| :-----------------: | :-----------------------------------------------------------------------------------------: | | ||
| use_defaults | If true use default commit types (default: true) | | ||
| custom_commit_types | Custom commit types to include when prompting, appended to defaults if `use_defaults: true` | | ||
|