diff --git a/docs/content/specs/shared/_index.md b/docs/content/specs/shared/_index.md index d8dcbad4a..56e1f8666 100644 --- a/docs/content/specs/shared/_index.md +++ b/docs/content/specs/shared/_index.md @@ -167,9 +167,29 @@ Today this is only Microsoft FTEs, but everyone is welcome to contribute. The mo #### ID: SNFR20 - Category: Contribution/Support - GitHub Teams Only -All GitHub repositories that AVM module are published from and hosted withing **MUST** only assign GitHub repository permissions to GitHub teams only. +All GitHub repositories that AVM module are published from and hosted within **MUST** only assign GitHub repository permissions to GitHub teams only. -They **MUST NOT** assign any GitHub repository permissions to individual users. +Each module **MUST** have separate GitHub Teams assigned for module owners **AND** module contributors respectively. + +There **MUST NOT** be any GitHub repository permissions assigned to individual users. + +The naming convention for the GitHub Teams **MUST** follow the below pattern: +- `@azure/-module-owners-` - to be assigned as the GitHub repository's `Module Owners` team +- `@azure/-module-contributors-` - to be assigned as the GitHub repository's `Module Contributors` team + +Segments: + +- `@azure` == the GitHub organization the AVM repository exists in +- `` == the AVM Module's name + - See [RMNFR1](#id-rmnfr1---category-naming---module-naming) for AVM Resource Module Naming + - See [PMNFR1](#id-pmnfr1---category-naming---module-naming) for AVM Pattern Module Naming +- `module-owners` or `module-contributors` == the role the GitHub Team is assigned to +- `` == the language the module is written in + +Examples: + +- `@azure/avm-res-compute-virtualmachine-module-owners-bicep` +- `@azure/avm-res-compute-virtualmachine-module-contributors-tf` #### ID: SNFR9 - Category: Contribution/Support - AVM & PG Teams GitHub Repo Permissions