Skip to content

Instantly share code, notes, and snippets.

@lcenchew
Last active May 27, 2023 10:20
Show Gist options
  • Save lcenchew/e4b5467c75b1645984fafe588338fb0b to your computer and use it in GitHub Desktop.
Save lcenchew/e4b5467c75b1645984fafe588338fb0b to your computer and use it in GitHub Desktop.
Example Conventional Commits #snippets #bookmarks

Conventional Commits

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
feat: Add view function
^--^  ^---------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: feat, fix, refactor, style, build, ci, docs, test.

Type:

  • feat: (new feature, function for main code)
  • fix: (bug fix for main code)
  • refactor: (code refactoring eg. renaming variable)
  • style: (changes that are just formatting, missing semi colons, etc;)
  • build: (changes related to packages, tools config file etc.)
  • ci: (changes related to automation, .github workflow etc.)
  • docs: (changes to the documentation)
  • test: (code related to tests)

Example:


🔼

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