Skip to content

Instantly share code, notes, and snippets.

@CodeLeom
Last active August 1, 2023 10:16
Show Gist options
  • Select an option

  • Save CodeLeom/fb0d0ed6a4818cbd5d2a29f7d44f682a to your computer and use it in GitHub Desktop.

Select an option

Save CodeLeom/fb0d0ed6a4818cbd5d2a29f7d44f682a to your computer and use it in GitHub Desktop.
Git Commit Convention, using the convention for writing git-commit messages. It is based on the AngularJS project (doc, commits).

Commit Message should come with a :

This means that, whatever you are working on, fall under the category of types mentioned below.

No. Type Description
1 feat use this type to describe a new feature
2 fix use this type to describe a bug fix
3 doc use this type to describe a documentation contribution or improvement
4 style use this type to describe formatting, missing semicolons, or page styling
5 refactor use this type to describe code refactor
6 test use this type to describe adding test to code or adding missing tests
7 chore use this type to describe maintainance, ex: travis-ci
8 perf use this type to describe performance improvement, optimization, etc.

Example usage

  1. git commit -m "feat: added checkout feature"
  2. git commit -m "docs(changelog): update changelog to beta.5"

You can add more as a comment or visit this Contribution Guide to read more about the convention.

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