diff --git a/doc/org-repo.md b/doc/org-repo.md index d213cb8..a6a11ae 100644 --- a/doc/org-repo.md +++ b/doc/org-repo.md @@ -1,10 +1,16 @@ # Organisation repo This repository itself is the entry point for documentation on official resources. +It is important that the documentation for the NixOS org governance is accurate. -Everybody in the [CODEOWNERS](../.github/CODEOWNERS) file has write permission to this repository. -This allows people to get automatic review requests and merge PRs for the files that concern them. -PRs can only be merged if a codeowner for the respective files approves it, and all files need to have a codeowner entry. +The [`CODEOWNERS`](../.github/CODEOWNERS) file indicates the persons or groups who have either ownership or a stake in a document. +In addition to being a document in its own right, the named parties are added as an automatic review requests, and can merge PRs for the files that concern them. +All files in this repository need to have an entry in the `CODEOWNERS` file. +This entry serves as documentation for who the interested and relevant parties are to that section of governance. -Furthermore, the code owners for the CODEOWNERS file should have permission to give more people write access to this repository. -These people get requested for reviews when new people add themselves to CODEOWNERS, allowing them to give write access when merged. +The [GitHub org owners](./github-org-owners.md) are themselves the codeowner for the `CODEOWNERS` file. +They have permission to give more people write access to this repository. +They get requested for reviews when new people add themselves to `CODEOWNERS`, and can give the relevant parties write access to the repository. + +Every person with write access can merge a PR in the repository. +The person who merges is responsible for doing so with due care.