Skip to content

Instantly share code, notes, and snippets.

@seunggabi

seunggabi/semantic-branch-names.md

Last active July 9, 2024 03:22
Show Gist options
  • Save seunggabi/87f8c722d35cd07deb3f649d45a31082 to your computer and use it in GitHub Desktop.
Save seunggabi/87f8c722d35cd07deb3f649d45a31082 to your computer and use it in GitHub Desktop.
Download ZIP
Semantic Branch Names
Raw
semantic-branch-names.md

Semantic Branch Names

See how a minor change to your branch name style can make you a better programmer.

Format: <type>/#<issueNumber>-<alias>

Example

feature/#1-init
^------^   ^---^
|          |
|          +---> issue's keyword
|
+-------> Type: or feat, chore, docs, fix, refactor, style, or test.

More Examples:

  • feat or feature: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

References:

@GyuminJack
Copy link

git commit -m 'feat: add prepare-commit-msg' -> branch :feature/DT-1252_#3_prepare-commit-msg

commit: [DT-1252] (#3) feat: add prepare-commit-msg

@gabrielpaiva-bycoders
Copy link

Hello!

If I'm creating a POC or studying something before start making a feature, what type this branch should be?

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