Skip to content

Instantly share code, notes, and snippets.

@bcaccinolo
Created November 16, 2017 15:50
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 bcaccinolo/bb5a3e2c74876b4370d78ea539b27b5e to your computer and use it in GitHub Desktop.
Save bcaccinolo/bb5a3e2c74876b4370d78ea539b27b5e to your computer and use it in GitHub Desktop.
Commit template
<type>(<scope>): <subject>
<body>
<footer>
#-------------------------------------------------------------------------------
# <type>
# - feat: A new feature
# - fix: A bug fix
# - docs: Documentation only changes
# - style: Changes that do not affect the meaning of the code (white-space,
# formatting, missing semi-colons, etc)
# - refactor: A code change that neither fixes a bug or adds a feature
# - perf: A code change that improves performance
# - test: Adding missing tests
# - chore: Changes to the build process or auxiliary tools and libraries
# such as documentation generation
# - content: Add content
#-------------------------------------------------------------------------------
# <scope>
# Before using scope, we have to define scopes of the application and store them
# in the documentation folder.
# By scope we mean an application part, not a technical part, for exemple
# search, add to cart, API…
#-------------------------------------------------------------------------------
# <subject>
# The subject contains succinct description of the change:
# - use the imperative, present tense: "change" not "changed" nor "changes"
# - don't capitalize first letter
# - no dot (.) at the end
#-------------------------------------------------------------------------------
# <body>
# The body should include the motivation for the change and be more detailled
# than the subject.
#-------------------------------------------------------------------------------
# <footer>
# The Footer list all related Issue Tracker links
#-------------------------------------------------------------------------------
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment