Skip to content

Instantly share code, notes, and snippets.

@isuke

isuke/.git_consistent

Created February 9, 2018 17:09
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save isuke/183057f709b14b997772ffee0a226e66 to your computer and use it in GitHub Desktop.
Save isuke/183057f709b14b997772ffee0a226e66 to your computer and use it in GitHub Desktop.
Download ZIP
git-consistent sample 01 default
Raw
.git_consistent
type:
type: enum
required: true
description: 'commit type'
values:
-
name: feat
description: 'when implementing function'
-
name: fix
description: 'when fixing a bug'
-
name: refactor
description: 'when refactoring'
-
name: ui
description: 'when improving UI'
-
name: docs
description: 'when writing docs'
-
name: test
description: 'when adding tests'
-
name: chore
description: "when change other that don't modify code or test files"
-
name: remove
description: 'when removing function'
-
name: perf
description: 'when improving performance'
-
name: ci
description: 'when fixing the CI build'
-
name: sec
description: 'when dealing with security'
-
name: up
description: 'when upgrading dependencies'
-
name: down
description: 'when downgrading dependencies'
-
name: tada
description: 'when celebrating'
-
name: revert
description: 'when reverts a previous commit'
scope:
type: enum
required: false
description: 'The scope could be specifying place of the commit change.'
prefix: '('
suffix: ')'
values:
-
name: "front"
description: 'front page'
-
name: "admin"
description: 'admin page'
subject:
type: string
required: true
description: 'The subject contains succinct description of the change'
body:
type: text
required: false
description: 'The body contains details of the change'
Raw
.gitcommit_template
<type><scope>: <subject>
<body>
Raw
README.md

This is git-consistent sample.

example commmits

feat(front): implement foo function

feat(admin): implement login page

This page is not styling.

docs: write README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment