You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: draft/code-management-guidance.md
+32-6Lines changed: 32 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,32 @@
1
-
# CivicActions DRAFT GitHub Use Policy
1
+
# CivicActions DRAFT Code Management Guidelines
2
2
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.
4
4
5
5
---
6
6
7
7
## 1. Governance: Corporate vs. Personal Repositories
8
8
9
9
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.
10
10
11
-
### Corporate GitHub Repository (use when…)
11
+
### Corporate public GitHub Repository (use when…)
12
12
- The work is **intended to be maintained** beyond the original author’s involvement.
13
13
- The project aligns with **client delivery, internal tooling, or CivicActions strategy**.
14
14
- The code is itended to be **reused, extended, or depended on** by others in the company.
15
15
- The work touches on **governance, compliance, or accessibility** standards where CivicActions must show accountability.
16
16
- The code is intended to be **shared widely** and is tied to our practices, projects or products.
17
17
- Documentation, issue tracking, or contribution from other staff will be needed.
18
18
- 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.
**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.
28
38
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
+
29
55
---
30
56
31
-
## 2. Attribution of CivicActions-Supported Work
57
+
## 3. Attribution of CivicActions-Supported Work
32
58
33
59
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.
34
60
@@ -40,7 +66,7 @@ When staff experiment during CivicActions-paid time, they should acknowledge Civ
0 commit comments