🚧 Repositories

ShortURL | Playbook | Assistant

NOTICE

This documentation page is under construction. Should you want to be notified once it's published, let us know.

This Handbook responds to the following Policies:

Prior readings

In order to better understand the contents of this document, it is recommended that you are familiar with the following materials:

CI/CD Policy / Procedure

Understanding it

Continuous integration vs. continuous delivery vs. continuous deployment

https://www.atlassian.com/continuous-delivery/principles/continuous-integration-vs-delivery-vs-deployment

Organization

Settings

Member privileges

Base permissions: NONE

Repositories

Repository structure

List of existing repositories

See JFQ Workspace

https://docs.google.com/spreadsheets/d/1Kb_JKQ-O9zSwT1M7RvnFaiWB0tGVeAG5bg3RYCBAgDQ/edit#gid=1973949268

Creating a new repository

Owner: TheIOFoundation

Repository Name: Follow convention

Description: Follow convention

Public / Private

Establish rule

Initialize this repository with:

Public

Private

Add Readme file

Grant your Marketplace apps access to this repository

Public

Private

None

Finishing the configuration

Public Repository

Social Preview

ON Restrict editing to users in teams with push access only

ON Issues

>> Set up Templates

ON Sponsorships

>> Set up Sponsorships

OFF Projects

ON Preserve this repository

ON Discussions

Merge Button Section

ON Allow squash merging

ON Automatically delete head branches

Private Repository

OFF Sponsorships

ON Restrict editing to users in teams with push access only

OFF Preserve this repository

Merge Button Section

ON Allow squash merging

ON Automatically delete head branches

Create Labels

Use the Label management scripts for this.

>> See Global #Tags

Branches:

Set Nomenclature convention

Commits

Add proper COMMIT MESSAGE (description)

Issues

https://guides.github.com/features/issues/

Creating Issue templates

Pull Request

Creating PR templates

https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository

Community Settings

Include the following items:

https://github.com/TheIOFoundation/ProjectLockdown/community

(sample repo)

Code of Conduct:

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project#adding-a-code-of-conduct-manually

Make it to the Wiki
+ CoC as per Gihub here: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project#adding-a-code-of-conduct-manually

Assigning Roles

https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization

Current idea:

Very likely we are better off creating Teams per Team + Subteams per Permission Type

Example

[TIOF PLD] Team Devs

[TIOF PLD] Team Devs - Triage

[TIOF PLD] Team Devs - Write

[TIOF PLD] Team Devs - Maintain

[TIOF PLD] Team Devs - Admin

That way we can keep granularity as we can’t assign these Permissions on a user-basis if they are in a Team and doing so would make it more complicated to track who can do what.