Skip to content

Instantly share code, notes, and snippets.

@olitreadwell
Created October 9, 2025 01:25
Show Gist options
  • Save olitreadwell/cb69538c21463144e04878f4e4ea015f to your computer and use it in GitHub Desktop.
Save olitreadwell/cb69538c21463144e04878f4e4ea015f to your computer and use it in GitHub Desktop.
gitmessage
#
# A well-formed Git commit message is mandatory.
# Follow the Conventional Commits format with emojis:
# <type>(<scope>): <description> [emoji]
#
# Examples:
# feat(authentication): add Google auth provider ✨
# fix(api): fix a regression in user creation πŸ›
# docs(readme): update contributing guide πŸ“š
# refactor(db): rename user table to accounts πŸ”¨
#
# ---
# Types:
# feat: A new feature
# fix: A bug fix
# docs: Documentation only changes
# style: Changes that do not affect code logic (white-space, formatting, 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
# chore: Other changes that don't modify src or test files
# build: Changes that affect the build system or external dependencies
# ci: Changes to our CI configuration files and scripts
#
# Scopes: (optional, but encouraged)
# The part of the codebase affected by the commit. e.g., 'auth', 'frontend', 'api'.
#
# Emojis (optional, but encouraged):
# ✨ new feature
# πŸ› bug fix
# πŸ“š documentation
# 🎨 style
# πŸ”¨ refactor
# πŸš€ performance
# βœ… tests
# ♻️ refactoring of some sort (e.g., code cleanup)
# βš™οΈ CI/CD or build system
# πŸ“¦ dependencies
# πŸ”– release / version tags
# πŸ”’ security
#
# ---
# Body:
# A more detailed explanation of the commit.
#
# ---
# Footer:
# BREAKING CHANGE: A change that breaks backward compatibility.
# Closes #<issue number>
#
#
#
# Use this section below to write your commit message:
#
# ----------------------------------------------------
# <type>(<scope>): <description>
#
#
#
#
#
#
#
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment