Semantic Branch Names

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:

• https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716

Interesting idea! 👏
Somewhat reminds me of gitflow

@palm002 thx

@palm002 @joshbuchea

https://gist.github.com/seunggabi/8fa40a3585d37519db5beab5f0563766

I recommend this prepare-commit-msg

start

• repository

cp prepare-commit-msg .git/hooks/prepare-commit-msg
chmod a+x .git/hooks/prepare-commit-msg

• global

mkdir -p ~/.git-templates/hooks
git config --global init.templatedir '~/.git-templates'
cp prepare-commit-msg ~/.git-templates/hooks/prepare-commit-msg
chmod a+x ~/.git-templates/hooks/prepare-commit-msg

# each repository
git init

example

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

branch: feature/DT-1252_prepare-commit-msg
commit: [DT-1252] feat: add prepare-commit-msg

branch: feature/#3_prepare-commit-msg
commit: (#3) feat: add prepare-commit-msg

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

Hello!

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

Hello!

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

Out of the existing ones, I would choose "feature" but I agree that it doesn't fit perfectly if there is an intention of starting over when creating the actual feature. Maybe "spike", "wip" or "poc" could work? Ultimately it's up to you and your team to decide.