jimeh/common-flow
1
0
Fork 0
mirror of https://github.com/jimeh/common-flow.git synced 2026-02-19 09:26:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add answer to "what does describe name mean?" FAQ question

Browse Source
This commit is contained in:
Jim Myhrberg
2017-08-26 23:20:34 +01:00
parent 68e0502dac
commit 77332f5f9a
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
common-flow.md
View File

@@ -286,7 +286,21 @@ releases, on top of what GitHub Flow already does.
**What does "descriptive name" mean in terms of change branches?** **What does "descriptive name" mean in terms of change branches?**
[answer goes here] It means what it sounds like. The name should be descriptive, as in by just
reading the name of the branch you should understand what the branch's purpose
is and what it does. Here's a few examples:
- add-2fa-support
- fix-login-issue
- remove-sort-by-middle-name-functionality
- update-font-awesome
- change-search-behavior
- tweak-footer-style
Notice how none of these have any prefixes like "feature/" or "hotfix/", they're
not needed when branch names are properly descriptive. However there's nothing
to say you can't use such prefixes if you want. That also means that you can add
ticket number prefixes if your team/org has that as part of it's process.
**What if there's a emergency hotfix that needs to be released, but for whatever **What if there's a emergency hotfix that needs to be released, but for whatever
reason, master has changes that cannot be released right now?** reason, master has changes that cannot be released right now?**