Skip to content

Instantly share code, notes, and snippets.

@prcaen

prcaen/git_commit_convention.markdown

Last active August 29, 2015 14:01
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save prcaen/3200a6cc4793d497b118 to your computer and use it in GitHub Desktop.
Save prcaen/3200a6cc4793d497b118 to your computer and use it in GitHub Desktop.
Download ZIP
Git commit convention
Raw
git_commit_convention.markdown

Git commit convention

Format

<type>(scope): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```

## Type
* feature
* fix
* refactor
* chore (config, build ...)
* test
* docs
* style (format like whitespace, change case ...)

## Scope (optional)
Scope of your code. In what part of the application you are doing some modification.

## Subject
Describe what you bring to the application and not to the code.

## Body
Some details on the commit or informations on I have change.

## Footer
references like:
  * Bugfix ids
  * User stories

## Examples

feature(login): reset password on demand

send an email with unique reset url
display a form to define a new password

Closes #1234

----
fix(search): find products containing special chars

escape characters: +\@&
doc: http://google.fr/search

Closes #789

## Source
http://www.parleys.com/play/535a2846e4b03397a8eee892/chapter0/about
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment