Skip to content

Commit 54d1812

Browse files
committed
Added naming conventions
1 parent bac2dd0 commit 54d1812

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/Developer/GitFlow.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,9 +194,17 @@ gitGraph TB:
194194
checkout SharedDev
195195
merge Release
196196
```
197+
## Naming Conventions
197198

199+
* Shared development branch: "SharedDevelopment"
200+
* Personal development branch: "*Name*Dev" or "*Name*Development", where "*name*" can be either the user's name or GitHub ID.
201+
* Feature branch: "issue-*XXX*-*description*", where "*XXX*" is the corresponding issue number and "*description*" is the issue title (possibly shortened).
202+
* Hotfix branches: "hotfix-issue-*XXX*-*description*"
203+
* Release branches: "release-v*##*", where *##* is the anticipated release tag.
204+
* Most pull requests: "[issue-*XXX*] *description*"
205+
* Release pull requests: "Release *##*"
198206

199-
# Why are we doing this?
207+
## Why are we doing this?
200208

201209
The information below is left-over details relating to how we used to do a release, when we only had one development branch and cherry-picked commits to merge into a release branch. Unfortunately, cherry picking doesn't preserve commit hashes, and so git eventually gets hopelessly confused about conflicts and merging into master then becomes very difficult.
202210

0 commit comments

Comments
 (0)