diff --git a/.github/.git_commit_template.txt b/.github/.git_commit_template.txt new file mode 100644 index 0000000000..5040eb39b4 --- /dev/null +++ b/.github/.git_commit_template.txt @@ -0,0 +1,2 @@ +# [TYPE](SCOPE):DESCRIPTION#[ISSUE] +# example feat(button):add type 'button' for form usage #1234 diff --git a/README.md b/README.md index c37c37a9af..2b0b48e6a7 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,16 @@ $ yarn gen component-name ``` Note the `component-name` must be in `kebab-case`, combining words by replacing each space with a dash. + +## Commit template +With command +```bash +yarn cz +``` + +Example +``` +[TYPE](SCOPE):DESCRIPTION#[ISSUE] +# example feat(button):add type 'button' for form usage #1234 +``` +