Skip to content

Instantly share code, notes, and snippets.

@semeano

semeano/conventionalcommits.md

Last active June 4, 2020 08:32
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 semeano/1504786331c8221a7e260a54f552a1d9 to your computer and use it in GitHub Desktop.
Save semeano/1504786331c8221a7e260a54f552a1d9 to your computer and use it in GitHub Desktop.
Download ZIP
Conventional Commits cheat sheet
Raw
conventionalcommits.md

Example of commit message convention:

<type>(<scope>): <subject>

<body>

<footer>

types:

  • feat: new features
  • fix: for bug fixes
  • build: changes that affect the build system or external dependencies
  • ci: changes to our CI configuration files and scripts
  • docs: documentation changes
  • perf: for performance improvements
  • style: for code style stuff
  • refactor: for code refactoring
  • test: for adding missing tests
  • chore: for relases, dependencies, stuff

subject:

  • use imperative, present tense (change, not changed or changes)
  • don't capitalize first letter
  • no . at the end

body:

  • use imperative (view subject)
  • include motivation for the change and contrast with previous behavior

footer:

  • should include reference to issues (github or JIRA or whatever)
  • should include breaking changes (should start with BREAKING CHANGE: )

Source

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment