Skip to content

Commit 9276049

Browse files
TCA-548 #comment This commit adds more details about branching and PRs #time 15m
1 parent c63b1ce commit 9276049

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -319,15 +319,31 @@ The PlatformRoute model has several useful options:
319319

320320
## Git
321321

322+
### Pull Requests
323+
324+
If a Jira ticket if requires any code changes, it should have its own pull request.
325+
326+
PRs should be named as follows:
327+
328+
`[TICKET-###] [Short Description] -> [target-branch-name]`
329+
330+
e.g. `GAME-174 Upload Badge Image Fix -> dev`
331+
322332
### Branching
323-
When working on Jira tickets, we link associated Git PRs and branches to the tickets. Use the following naming convention for branches:
324333

325-
`[TICKET #]_short-description`
334+
All branches use `dev` as their source. All merges to `dev` should be made via [pull request](#pull-requests) and should be approved by application owner(s).
335+
336+
When working on Jira tickets, a branch should correspond with a single ticket.
337+
338+
When using subtasks, each parent ticket should have its own branch off `dev`, and all subtasks branches should be merged into the parent ticket branch instead of directly to `dev`.
339+
340+
Use the following naming convention for branches in order to link associated Git PRs and branches to the tickets:
341+
342+
`[TICKET-###]_short-description`
326343

327344
e.g.: `PROD-1516_work-issue`
328345

329346
#### Branching strategy
330-
TBD
331347

332348
### Commits
333349
We use [Smart Commits](https://bigbrassband.com/git-integration-for-jira/documentation/smart-commits.html#bbb-nav-basic-examples) to link comments and time tracking to tickets. You would enter the following as your commit message:

0 commit comments

Comments
 (0)