From 1636639c6c368a6fcad10428fbe7117651d897bf Mon Sep 17 00:00:00 2001 From: Elizabeth Sall Date: Fri, 12 Jan 2024 18:00:29 -0800 Subject: [PATCH 1/2] add mermaid diagram with git graph diagram showing branching model --- docs/governance/policies/change-management.md | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/governance/policies/change-management.md b/docs/governance/policies/change-management.md index 2a359c72..d72f2d28 100644 --- a/docs/governance/policies/change-management.md +++ b/docs/governance/policies/change-management.md @@ -317,6 +317,42 @@ The following branches SHOULD always be maintained: - [ ] Each branch SHOULD represent a maximum of one [change proposa](#change-making-stages)l. - [ ] Feature branches in the TIDES version control repository which have not been updated in 6 months MAY be archived. +Example branching actions shown below: + +```mermaid +%%{init: { 'logLevel': 'debug', 'theme': 'base' } }%% + gitGraph: + commit tag: "v1.0.0" + branch develop + commit + branch spec-change-a + branch spec-change-b + checkout spec-change-a + commit id: "Add table" + commit id: "Add documentation for table" + checkout develop + merge spec-change-a tag: "v1.1-alpha.1" + checkout spec-change-b + commit id: "Add column" + commit id: "Add documentation for column" + checkout develop + merge spec-change-b tag: "v1.1-alpha.2" + commit id: "Update sample data" + checkout main + commit id: "documentation update" + branch code-feature + commit id: "add new test" + commit id: "add documentation about test" + checkout main + merge code-feature + checkout develop + merge main id: "Update with changes to main" tag: "v1.1-beta.1" + commit id: "bugfix" + commit id: "Add changelog, documentation for release" tag: "v1.1-beta.2" + checkout main + merge develop tag: "v1.1" +``` + ## Attribution **_This change management policy is adapted from:_** From 07f213a6f4a22e2aa4dbb38195f66aedd3db7390 Mon Sep 17 00:00:00 2001 From: Soren Spicknall Date: Mon, 22 Jan 2024 14:54:10 -0600 Subject: [PATCH 2/2] Capitalization changes (to test CI) --- docs/governance/policies/change-management.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/governance/policies/change-management.md b/docs/governance/policies/change-management.md index d72f2d28..0f3ef502 100644 --- a/docs/governance/policies/change-management.md +++ b/docs/governance/policies/change-management.md @@ -339,10 +339,10 @@ Example branching actions shown below: merge spec-change-b tag: "v1.1-alpha.2" commit id: "Update sample data" checkout main - commit id: "documentation update" + commit id: "Documentation update" branch code-feature - commit id: "add new test" - commit id: "add documentation about test" + commit id: "Add new test" + commit id: "Add documentation about test" checkout main merge code-feature checkout develop