Document development branch workflow
This commit is contained in:
parent
cb69941884
commit
a6dbf9623a
@ -2,6 +2,43 @@
|
|||||||
|
|
||||||
This guide covers the usual path for adding or changing a Forge module.
|
This guide covers the usual path for adding or changing a Forge module.
|
||||||
|
|
||||||
|
## Repository Workflow
|
||||||
|
|
||||||
|
Use [Git Workflow](./GIT_WORKFLOW.md) as the source of truth for branch roles,
|
||||||
|
release tags, and mission branch handling. The short version is:
|
||||||
|
|
||||||
|
- Use `pre-v0.2` for framework development after the `v0.1.0` baseline.
|
||||||
|
- Keep `master` as the clean release baseline branch.
|
||||||
|
- Keep mission folders off `master`; mission work belongs on
|
||||||
|
`missions/local-mission-copies`.
|
||||||
|
- Keep `archive/pre-v0.1-history` read-only unless recovering old work.
|
||||||
|
- Bring reusable mission logic back to framework branches by copying only the
|
||||||
|
needed framework files or code, not by merging the mission branch.
|
||||||
|
|
||||||
|
Example framework workflow:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
git switch pre-v0.2
|
||||||
|
git pull
|
||||||
|
git switch -c feature/cad-task-request
|
||||||
|
|
||||||
|
# make framework changes
|
||||||
|
git status --short --branch
|
||||||
|
git add arma/client/addons/cad arma/server/addons/cad
|
||||||
|
git commit -m "Add CAD task request workflow"
|
||||||
|
```
|
||||||
|
|
||||||
|
Example mission workflow:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
git switch missions/local-mission-copies
|
||||||
|
|
||||||
|
# make mission changes
|
||||||
|
git status --short --branch
|
||||||
|
git add arma/forge_pmc_simulator.Tanoa
|
||||||
|
git commit -m "Update PMC simulator mission setup"
|
||||||
|
```
|
||||||
|
|
||||||
## Local Checks
|
## Local Checks
|
||||||
|
|
||||||
Before running storage-backed workflows locally, complete
|
Before running storage-backed workflows locally, complete
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user