Source Code Management - yibinericxia/documents GitHub Wiki
Overview
Branching Strategy
The branching is based on JIRA type and has its own environment for consideration. The master branch is the central one which all other branches are coordinated. Developers need to create a branch along with a draft PR for daily changes to avoid lost.
| JIRA type | Branch name | PR target branch | Environment |
|---|---|---|---|
| story | story/$JIRA-ID | feature | k8s |
| epic/feature | feature/$JIRA-ID | master | UAT |
| QA bug | bug/$JIRA-ID | master | UAT |
| prod bug | ticket/$JIRA-ID | release/$yyyy-$mm-$dd | CERT |
| releases | release/$yyyy-$mm-$dd | master (auto reverse merge) | CERT & Prod |
SCM Tools/Platforms
Github
Markdown with Mermaid
- Markdown .md file under root or/and each component directory
- Mermaid is a JavaScript tool which creates different diagrams dynamically in the browser.
Github Copilot
References: