Skip to content

Commit cf46642

Browse files
authored
#210 conventions for GitHub teams
1 parent 2acab8b commit cf46642

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

practices/security-repository.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This guide lays out security best practice for Github repositories. This set of
1010
## Access controls
1111
### Organisation-level settings
1212
* All users must have MFA enabled.
13-
* Baseline visibility for private repositories must be "no permission".
13+
* Baseline visibility for private repositories must be `No Permission`.
1414
* Ability to change repository view from private to public must be reserved to admins only.
1515

1616
### Repository-specific settings
@@ -19,6 +19,15 @@ This guide lays out security best practice for Github repositories. This set of
1919
* There must be no outside collaborators in private repositories.
2020
* Enable abuse reporting by [accepting content reports](https://docs.github.com/en/communities/moderating-comments-and-conversations/managing-how-contributors-report-abuse-in-your-organizations-repository)
2121

22+
### Teams setup
23+
Because of baseline visibility configurations, you must setup Github teams in order to provide team members access to repos. The minimum recommended setup is as follows:
24+
* Create one team with the name of your programme (e.g. `Engineering Quality Framework`). Add all required members to this team.
25+
* Create one child team within the team, for admins only (e.g. `Engineering Quality Framework Admins`). Add admins only to this team.
26+
* Create a second child team, for code owners (e.g. `Engineering Quality Framework Code Owners`). Add relevant members to this team, and reference in the CODEOWNERS file (example [here](https://github.com/NHSDigital/software-engineering-quality-framework/blob/master/CODEOWNERS)).
27+
* For each repo in your programme (e.g. `software-engineering-quality-framework`), under the `Manage Access` option in `Settings`, set the general team to have `Write` access and the admins team to have `Admin` access.
28+
29+
Depending on your use case, you may want to create additional teams (e.g. a read-only access team, or different teams granting access to different projects). This is welcomed by the framework, as long as the teams provide clarity on the role they encompass, remain consistent and are applied consistently to your repos.
30+
2231
## Code security
2332
* Enable, at a minimum, [Dependabot](https://github.blog/2020-06-01-keep-all-your-packages-up-to-date-with-dependabot/) alerts for vulnerabilities and respond to them appropriately.
2433
* Disable ability to push to the default branch for everyone, admins included (`applies-to-admin` option).

0 commit comments

Comments
 (0)