Skip to content

Commit fac94f0

Browse files
authored
Update and rename Use-Policy.md to code-management-guidance.md
Update based on discussions with Owen & Daniel M.
1 parent 74be7cb commit fac94f0

File tree

1 file changed

+32
-6
lines changed

1 file changed

+32
-6
lines changed

draft/Use-Policy.md renamed to draft/code-management-guidance.md

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,32 @@
1-
# CivicActions DRAFT GitHub Use Policy
1+
# CivicActions DRAFT Code Management Guidelines
22

3-
This is a DRAFT policy outlines when work should go into the CivicActions corporate GitHub repository versus a personal repository, and how to attribute CivicActions support when experimenting 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 licneses](https://opensource.org/licenses) can also be appropriate.
3+
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 licneses](https://opensource.org/licenses) can also be appropriate.
44

55
---
66

77
## 1. Governance: Corporate vs. Personal Repositories
88

99
CivicActions wants to track Practices (org-wide methods, standards, shared tools), Projects (client or internal initiatives) and Products (open-source tools we want to sustain). We do not want to restrict creativity and experimentation of our team, but we do want to be able to maintain our corporate repositories.
1010

11-
### Corporate GitHub Repository (use when…)
11+
### Corporate public GitHub Repository (use when…)
1212
- The work is **intended to be maintained** beyond the original author’s involvement.
1313
- The project aligns with **client delivery, internal tooling, or CivicActions strategy**.
1414
- The code is itended to be **reused, extended, or depended on** by others in the company.
1515
- The work touches on **governance, compliance, or accessibility** standards where CivicActions must show accountability.
1616
- The code is intended to be **shared widely** and is tied to our practices, projects or products.
1717
- Documentation, issue tracking, or contribution from other staff will be needed.
1818
- Build to align with our Check My Repo https://github.com/CivicActions/check-my-repo
19-
- Security, licensing, and support responsibilities fall to CivicActions.
19+
- Security, licensing, and support responsibilities fall to CivicActions.
20+
21+
### Corporate private GitLab Repository (use when…)
22+
- If we want to collaborate internally, but do not want to publish the code publicly.
23+
- We may wan to do this as a type of InnerSource project where we want to facilitate collaboration inside of CivicActions.
24+
- This is intended for use for internal projects that do not make sense to open source because they are:
25+
- too experimental
26+
- too specific to our needs or
27+
- entangled in our infrastructure specifics
28+
- If these (or components of them) become potentially useful, those should be open sourced on our GitHub organization.
29+
- Our Gitlab should only be used for private code.
2030

2131
### Personal or Private Repositories (use when…)
2232
- The work is **exploratory, throw-away, or highly experimental**, and may never be maintained.
@@ -26,9 +36,25 @@ CivicActions wants to track Practices (org-wide methods, standards, shared tools
2636

2737
**Rule of thumb:** If CivicActions or its clients will **depend** on it, it belongs in the corporate repo. If it’s **personal exploration**, keep it in a personal repo unless and until it becomes company-backed.
2838

39+
40+
## 2. Work for CivicActions' clients
41+
42+
Clients may have their own public and/or private repositories. All work that we do for our clients needs to be mindful of our contractual responsibilities.
43+
44+
- Client repositories (which can be internal or public) should be used for all project code unless we have approval from both:
45+
- CivicActions legal team (once per-contract - we need to review contract terms) and
46+
- From the client (specific approval needed for each new project/library).
47+
- CivicActions requires approval from the client before before both:
48+
- hosting the code outside a client system, and;
49+
- open sourcing it.
50+
- If CivicActions' clients don't have their own repositories available to us, after obtaining permission from the client, we can use:
51+
- CivicActions GitHub - typically if they want to open source it, or move it to another Github org later on;
52+
- CivicActions GitLab - needed if we also need CivicActions CI infrastructure
53+
54+
2955
---
3056

31-
## 2. Attribution of CivicActions-Supported Work
57+
## 3. Attribution of CivicActions-Supported Work
3258

3359
When staff experiment during CivicActions-paid time, they should acknowledge CivicActions’ support while respecting personal repositories. Anyone at CivicActions should feel free to fork a project into the CivicActions repository if it is relevent to practices, projects or products we are working on. With personal projects of staff, it is good to reach out.
3460

@@ -40,7 +66,7 @@ When staff experiment during CivicActions-paid time, they should acknowledge Civ
4066

4167
---
4268

43-
## 3. Decision Tree
69+
## 4. Decision Tree
4470

4571
```mermaid
4672
flowchart TD

0 commit comments

Comments
 (0)