GitHub Repo Management
- Drummond Reed
- Kevin Griffin
When a Working Group or Task Force ("group") begins using a GitHub repo to maintain a ToIP deliverable (specification, template, white paper, etc.), our GitHub Issues Management recommends that the group appoint a set of Editors and a set of Maintainers (who are typically a subset of the Editors) to maintain the repo. This page documents the recommended process the Editors and Maintainers should follow to manage the repo, merge PRs, and publish versions of the deliverable.
There are only two hard things in Computer Science: cache invalidation and naming things.
-- Phil Karlton
We aim to have a simple, consistent approach to naming repositories. Starting with the working group prefix i.e. tswg (technology stack working group) and then a common sense abbreviated version of the output.
Specifications:
Prefix with the Working Group acronym, we omit the Task Forces acronym as TFs can be short-lived whereas WGs are chartered components of ToIP, so we attribute deliverables to the higher entity.
Suffix with spec/specification (TBD)
- tswg-keri-specification
Terminology/Glossary:
Terminology repositories are used to capture terms used within a specific working group and are named accordingly to simplify discovery and aggregation.
No suffix to help readability
- toip - terms for our foundation (https://trustoverip.github.io/toip/glossary )
- tswg - terms for a working group
- acdc - terms for a task force
Templates:
As templates can be reused across WGs there is no formal prefix.
For example, the ISO template was created by the TSWG but could be reused by any WG wishing to pursue ISO standardization.
Suffix with template.
- iso-template
Guide:
Prefix with the Working Group acronym, we omit the Task Forces acronym as TFs can be short-lived whereas WGs are chartered components of ToIP, so we attribute deliverables to the higher entity.
Suffix with guide.
- tswg-a-guide
Paper:
Prefix with the Working Group acronym, we omit the Task Forces acronym as TFs can be short-lived whereas WGs are chartered components of ToIP, so we attribute deliverables to the higher entity.
Suffix with paper.
- tswg-a-paper
Bespsoke:
In some cases we've needed bespoke repo names to support community efforts such as the vLEI EGF public review:
- egf-vlei-review
Owners of the ToIP GitHub organization will work with a working group, a task force or an individual to provide support for repositories for deliverables. Depending on the final destination of a work item ToIP uses a number of different repository templates including ITEF and ISO ones.