Configuration of members, teams, repository permissions, and more.
These settings are automatically synchronised using github-org-manager.
Maintainers of OpenRail Association projects can request changes to their teams' and repositories' permissions. Please create a pull request in order to do so.
After the changes have been approved and merged, the changes will be executed via GitHub actions which takes ~2 minutes.
Each team file under teams/ uses a prefix indicating the type of team:
| Prefix | Purpose | Example |
|---|---|---|
project- |
OpenRail incubation projects | project-osrd.yaml |
wg- |
Working groups | wg-project-scouting.yaml |
org- |
Organizational teams (OpenRail Team, TC, admin projects, meetup) | org-technical-committee.yaml |
external- |
External collaborations | external-hack4rail.yaml |
Each project or group gets exactly one file. Do not add your teams in another file.
- Team names are human-readable text with proper capitalization and spaces:
NGE Maintainers, notNGE-Adminsornge-maintainers. - Prepend your project name to keep names unique:
DAC Migration DSS Maintainers,Liblrs Maintainers. - Use "Maintainers" (not "Admins") for the elevated-permissions sub-team.
Every team must have a description field. Use one of these patterns:
- Base team: "Members of the X project" / "Members of the X Working Group"
- Maintainer sub-team: "Maintainers of the X project" / "Maintainers of the X repository"
- Special-purpose teams: descriptive phrase ("Organizers of the Hack4Rail event", "Moderators of the Technical Committee retrospectives")
No leading "The" in descriptions.
- A project's base team gets
pushpermission on its repos. - A "Maintainers" sub-team (with
parentset to the base team) getsadminpermission for people who need to manage repo settings, branch protection, etc. - Do not add individual user permissions to repositories. Use teams only.
- All organization members must belong to at least one team.
The content of this repository is licensed under the Apache 2.0 license.