Skip to content

Instantly share code, notes, and snippets.

@Benjaminsson
Forked from Zekfad/conventional-commits.md
Last active November 28, 2025 12:43
Show Gist options
  • Select an option

  • Save Benjaminsson/79529d5d867cb3e2e28139fb21b3a81f to your computer and use it in GitHub Desktop.

Select an option

Save Benjaminsson/79529d5d867cb3e2e28139fb21b3a81f to your computer and use it in GitHub Desktop.
Conventional Commits Cheatsheet

Quick examples

  • feat: New feature
  • fix(scope): Bug in scope
  • feat!: Breaking change / feat(scope)!: rework API
  • chore(deps): Update dependencies

Commit types

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • chore: Changes which doesn't change source code or tests e.g. changes to the build process, auxiliary tools, libraries
  • docs: Documentation only changes
  • feat: Add or remove a feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • revert: Revert something
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Version bumps

  • fixpatch version bump (1.0.01.0.1)
  • featminor version bump (1.0.01.1.0)
  • breaking changes (! or BREAKING CHANGE:)major version bump (1.0.02.0.0)
Commit example Bump type Resulting version Notes
fix: correct minor typo Patch 1.0.0 → 1.0.1 For bug fixes
feat: add user login Minor 1.0.0 → 1.1.0 Adds new functionality
feat!: overhaul API Major 1.0.0 → 2.0.0 Breaking change (!)
refactor: cleanup utils None No version bump
docs: update README None No version bump

Reminders

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