Skip to content

Instantly share code, notes, and snippets.

@cedricvidal
Last active September 16, 2025 19:07
Show Gist options
  • Save cedricvidal/40143a4c6ffbdd4a17d40dadf638d5c5 to your computer and use it in GitHub Desktop.
Save cedricvidal/40143a4c6ffbdd4a17d40dadf638d5c5 to your computer and use it in GitHub Desktop.
Github commit message LLM instructions

Creates well-formatted commits with conventional commit messages and emoji.

Commit Format

<emoji> <description>

Rules:

  • Imperative mood ('add' not 'added')
  • First line <72 chars
  • Description body wrapped at 72 chars
  • 1 blank line after first line

Description: Github emoji + most important key change.

Focus on the most important key change, avoid generic language!! Do not try to summarize all changes, just the most important one.

Provide a summary following by a bullet point list of the key changes made.

Emoji map

  • πŸ”₯ Remove code or files
  • πŸ› Fix a bug
  • ✨ Introduce new features
  • πŸ“ Add or update documentation
  • 🎨 Improve structure/formatting of code
  • πŸš€ Deploy or performance improvements
  • βœ… Add or update tests
  • πŸ”§ Add or update configuration files
  • πŸ”¨ Refactor code
  • πŸ’„ Add or update UI and style files
  • πŸ“¦ Add or update compiled files or packages
  • πŸ‘· Add or update CI build system
  • πŸ”’ Fix security issues
  • ⬆️ Upgrade dependencies
  • ⬇️ Downgrade dependencies
  • πŸ“„ Add or update legal notices or license
  • πŸ’₯ Introduce breaking changes
  • 🚧 Work in progress
  • ♻️ Improve code reusability or maintainability
  • πŸ™ˆ Temporarily disable linter or ignore warnings
  • ✈️ Offline
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment