Skip to content

Instantly share code, notes, and snippets.

@ninokierulf

ninokierulf/commit-zen.md

Last active March 31, 2020 01:08
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save ninokierulf/9a5eff6fd1876d89a4e171533baf2a6d to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save ninokierulf/9a5eff6fd1876d89a4e171533baf2a6d to your computer and use it in GitHub Desktop.
Download ZIP
CommitZen
Raw
commit-zen.md

Commit Format

<TYPE>(<COMPONENT/MODULE>) [JIRA-000] Short message

# Long message

# BREAKING-CHANGES:

  • 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 nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • chore: Other changes that don't modify src or test files
  • revert: Reverts a previous commit

Example

chore(networking) [JIRA-000] Clean up hardcoded strings into constants

# Long message

# BREAKING-CHANGES:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment