Skip to content

Instantly share code, notes, and snippets.

@yifanzz

yifanzz/git-usage-prompt.md

Created November 16, 2024 19:49
Show Gist options
  • Save yifanzz/9ecfe4616328fbbb1d9eee4515c39efc to your computer and use it in GitHub Desktop.
Save yifanzz/9ecfe4616328fbbb1d9eee4515c39efc to your computer and use it in GitHub Desktop.
Download ZIP
EP9 Notes
Raw
git-usage-prompt.md

Git Usage

  • use the following prefixes for commit messages followed by a colon and a space:
    • "fix" for bug fixes
    • "feat" for new features
    • "perf" for performance improvements
    • "docs" for documentation changes
    • "style" for formatting changes
    • "refactor" for code refactoring
    • "test" for adding missing tests
    • "chore" for chore tasks
  • when determining the commit message prefix, pick the most relevant prefix from the list above
  • use lower case for commit messages
  • the commit message should also include a list of the changes made in the commit after the summary line if the changes are not self explanatory
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment