The IO Foundation
Search
⌃K
Links

🚧 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

Organization

Settings

Member privileges
Base permissions: NONE

Repositories

Repository structure

List of existing repositories

See JFQ Workspace

​

Tags

Please refer to the Tags Handbook.
​
​
​

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
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:
  • 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

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.

Labels

Each label type should be represented by a specific color code according to their category. See table below.
Project
ORG
PLD
UDDR
BiT
Team:
(List of teams)
Level:
Coordinator
Deputy
Member
@@@Pending missing
Module:
PLD
API
DB
DEI
MAP
WEB
Version
Position
Staff
Volunter
Keywords
Collection of any other labels needed that may help
Priority
Critical
High
Medium
Low
Type
Bug
Enhancement
Error
Question
Need:
Position
Tool
Funding
Categories
Custom Fields
Lat
Long
Due Date
Documentacion sources
https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/about-labels
Project coding guidelines
Comments
Diagrams
Unit tests

Other useful stuff

Mastering Markdown

https://guides.github.com/features/mastering-markdown/

Your GitHub Profile

Use your official TIOF profile picture any time possible
(Mandatory for TIOF Staff)
You can have your own TIOF/PLD GitHub account if you will. It depends on you.
Bio (only allows 160 characters)
Organization
The IO Foundation
[TIOF] Project Lockdown
Location (optional)
Email: TIOF/PLD email
Link: Preferably LinkedIn others also can
Twitter: In applicable
Organizations:
Should appear automatically

Chrome Extensions

Google Apps Script GitHub Assistant

Octotree - GitHub code tree

Post to GitHub

To evaluate
Visual Markdown Extension

GitHub Apps to explore