Skip to content

Instantly share code, notes, and snippets.

@istiaqhossain

istiaqhossain/conventional-commits.md

Created December 29, 2023 20:11
Show Gist options
  • Save istiaqhossain/0af70e90011d8dde708df5d975636af2 to your computer and use it in GitHub Desktop.
Save istiaqhossain/0af70e90011d8dde708df5d975636af2 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
conventional-commits.md

Example of commit message convention:

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

<body>

<footer>

Quick examples

  • feat: new feature
  • fix(scope): bug in scope
  • feat!: breaking change / feat(scope)!: rework API
  • chore(deps): update dependencies

types:

  • feat: Feature A new feature
  • fix: Bug Fixes A bug fix
  • build: Builds Changes that affect the build system or external dependencies
  • ci: Continuous Integrations Changes to our CI configuration files and scripts
  • docs: Documentation Documentation only changes
  • perf: Performance Improvements A code change that improves performance
  • style: Styles Code style stuff
  • refactor: Code Refactoring A code change that neither fixes a bug nor adds a feature
  • test: Tests Adding missing tests or correcting existing tests
  • chore: Chores Other changes that don't modify src or test files, for relases, dependencies, stuff
  • revert: Reverts Reverts a previous commit

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: )

Refs:

Angular Guidelines

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