Skip to content

Commit 1e83e66

Browse files
authored
Update code-management-guidance.md
Conslodating flow charts
1 parent 4f347e7 commit 1e83e66

File tree

1 file changed

+32
-118
lines changed

1 file changed

+32
-118
lines changed

draft/code-management-guidance.md

Lines changed: 32 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -70,125 +70,39 @@ When staff experiment during CivicActions-paid time, they should acknowledge Civ
7070

7171
This is a DRAFT guidance outlines when work should go into the CivicActions corporate repositories (GitHub & GitLab), our client repositories, or a personal repository. The guidance should direct the team how to attribute CivicActions or client support behind the repositories. This is particularly important when experimenting with code on paid time. All projects should have an appropriate license. CivicActions default license should be the [AGPL v3](https://opensource.org/license/agpl-v3), but other [OSI-approved licenses](https://opensource.org/licenses) can also be appropriate.
7272

73-
---
74-
75-
## Decision Tree 1
76-
77-
```mermaid
78-
flowchart TD
79-
A[Do you expect others at CivicActions to use or depend on this work?] -->|Yes| B[Put it in the Corporate GitHub Repo]
80-
A -->|No| C[Is this just personal learning or an experiment?]
81-
82-
C -->|Yes| D[Keep it in a Personal Repo<br/>Add note: 'Supported in part by CivicActions']
83-
C -->|No| E[Does it align with client delivery or CivicActions strategy?]
84-
85-
E -->|Yes| B
86-
E -->|No| D
87-
88-
B --> F[Add docs & follow CivicActions governance]
89-
```
90-
91-
## Decision Tree 2
92-
93-
```mermaid
94-
flowchart TD
95-
A[Do you expect others at CivicActions to use or depend on this work?] -->|Yes| B[Put it in the Corporate GitHub Repo]
96-
A -->|No| C[Is this just personal learning or an experiment?]
97-
98-
C -->|Yes| D[Keep it in a Personal Repo<br/>Add note: 'This work was initiated with support from CivicActions.']
99-
C -->|No| E[Does it align with client delivery or CivicActions strategy?]
100-
101-
E -->|Yes| F[Is it suitable for public sharing?]
102-
F -->|Yes| B
103-
F -->|No| G[Put it in the Corporate GitLab Repo]
104-
105-
E -->|No| H[Is it client work?]
106-
H -->|Yes| I[Does the client have a repository?]
107-
I -->|Yes| J[Use the client's repository]
108-
I -->|No| K[Obtain client approval to use CivicActions GitHub or GitLab]
109-
110-
H -->|No| D
111-
112-
B --> L[Add docs & follow CivicActions governance]
113-
G --> L
114-
J --> L
115-
K --> L
116-
```
117-
118-
## Decision Tree 3
119-
120-
```mermaid
121-
flowchart TD
122-
A[Is this work associated with a contract and a deliverable?] -->|Yes| B[Is this work for CivicActions?]
123-
A -->|No| D[Keep it in a Personal Repo<br/>Add note: 'This work was initiated with support from CivicActions.']
124-
125-
B -->|Yes| C[Is this a team project?]
126-
B -->|No| E[Put it in the Personal GitHub Repo]
127-
128-
C -->|Yes| F[Put it in the Corporate GitHub Repo]
129-
C -->|No| E
130-
131-
F --> G[Add docs & follow CivicActions governance]
132-
```
133-
134-
## Decision Tree 4
135-
13673
```mermaid
13774
flowchart TD
138-
A[Is this work associated with a contract and a deliverable?] -->|Yes| B[Is this work for CivicActions?]
139-
A -->|No| D[Keep it in a Personal Repo<br/>Add note: 'This work was initiated with support from CivicActions.']
140-
141-
B -->|Yes| C[Is this a team project?]
142-
B -->|No| E[Put it in the Personal GitHub Repo]
143-
144-
C -->|Yes| F[Put it in the Corporate GitHub Repo]
145-
C -->|No| E
146-
147-
F --> G[Add docs & follow CivicActions governance]
148-
149-
B -->|No| H[Is it client work?]
150-
H -->|Yes| I[Does the client have a repository?]
151-
I -->|Yes| J[Use the client's repository]
152-
I -->|No| K[Obtain client approval to use CivicActions GitHub or GitLab]
153-
154-
H -->|No| D
155-
156-
J --> L[Add docs & follow CivicActions governance]
157-
K --> L
158-
```
159-
160-
161-
## Decision Tree 5
162-
163-
164-
https://www.mermaidchart.com/app/projects/0d29f810-93fc-41dd-a9bf-f11e05365a4f/diagrams/61285e29-16c4-4575-9b8f-303737b05654/version/v0.1/edit
165-
166-
```mermaid
167-
flowchart
168-
Project[You want to publish something you did at CivicActions] -->|Yes| Client[Is it for a client?]
169-
170-
Client -->|Yes| Approval[Do we have approval to make it public?]
171-
Client -->|No| Team[Do you want to work with it with CA team?]
172-
173-
Approval -->|No| EE[Do we want to work on it within CivicActions?]
174-
Team --> |Yes| GitLab[do we want to work in private?]
175-
Team --> |No| GitHubPersonal
176-
177-
EE --> |Yes| GG[Add docs & follow CivicActions governance]
178-
Approval --> HH[Add docs & follow CivicActions governance]
179-
180-
GitLab --> E[rad oub]
181-
GitHubCA --> F[Put it on CA GitHub]
182-
GitHubPersonal[Put it on Personal GitHub]
183-
184-
Approval -->|No| E[Put it on GitLab]
185-
186-
H -->|Yes| I[Does the client have a repository?]
187-
I -->|Yes| J[Use the client's repository]
188-
I -->|No| K[Obtain client approval to use CivicActions GitHub or GitLab]
189-
190-
191-
J --> L[Add docs & follow CivicActions governance]
192-
K --> L
75+
Project["You want to publish something you did at CivicActions"]
76+
Client{"Is it for a client?"}
77+
ClientRepo{"Does the client have a repo?"}
78+
NeedCA{"Do you have plans to work on it with the CA team?"}
79+
WantPublic{"Do we want to publish it publicly?"}
80+
Approval{"Do we have approval to make it public?"}
81+
UseClientRepo["Host it in the client's repo"]
82+
UseCAGH["Put it on CA GitHub (public)"]
83+
UseCAGL["Put it on CA GitLab (private)"]
84+
UsePersonalGH["Put it on your personal GitHub (public)"]
85+
Docs["Add docs and follow CivicActions governance"]
86+
DocsPersonal["Add an OSI license and credit CivicActions"]
87+
88+
Project --> Client
89+
Client -->|Yes| ClientRepo
90+
Client -->|No| NeedCA
91+
92+
ClientRepo -->|Yes| UseClientRepo
93+
ClientRepo -->|No| WantPublic
94+
95+
NeedCA -->|Yes| WantPublic
96+
NeedCA -->|No| UsePersonalGH
97+
98+
WantPublic -->|Yes| Approval
99+
WantPublic -->|No| UseCAGL
100+
101+
Approval -->|Yes| UseCAGH
102+
Approval -->|No| UseCAGL
103+
104+
UseCAGH --> Docs
105+
106+
UsePersonalGH --> DocsPersonal
193107
```
194108

0 commit comments

Comments
 (0)