From 508cea73145a89911fc23b637053aad2ea74fcb0 Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Fri, 15 Dec 2023 06:09:34 +0000 Subject: [PATCH] COMMUNITY-ROLES: document CODEOWNERS file (#11646) * COMMUNITY-ROLES: Document CODEOWNERS file * Update COMMUNITY-ROLES.md Co-authored-by: K.B.Dharun Krishna * Update COMMUNITY-ROLES.md Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> * Update COMMUNITY-ROLES.md Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> * Update COMMUNITY-ROLES.md Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> * COMMUNITY-ROLES: add licence clarification note ref @kbdharun * Update COMMUNITY-ROLES.md Co-authored-by: K.B.Dharun Krishna --------- Co-authored-by: K.B.Dharun Krishna Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> --- COMMUNITY-ROLES.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/COMMUNITY-ROLES.md b/COMMUNITY-ROLES.md index 290ea9a81..844f587f3 100644 --- a/COMMUNITY-ROLES.md +++ b/COMMUNITY-ROLES.md @@ -203,3 +203,17 @@ Any member of the community can (and is encouraged to) propose role changes by following the process outlined [above](#how-to-change-roles). [Owners of the tldr-pages organization](MAINTAINERS.md#organization-owners) can then perform the actual role changes. + +## CODEOWNERS + +The [`.github/CODEOWNERS` file](https://github.com/tldr-pages/tldr/blob/main/.github/CODEOWNERS) allows contributors with write access to the [tldr-pages/tldr repository](https://github.com/tldr-pages/tldr) to get automatic review request notifications for given files and directories. +If they wish to, contributors can open a pull request to add themselves to this file as desired. + +Example uses include (but are not limited to): + +- Contributors who speak a specific language and want to assist with reviewing translations in those specific languages. +- Contributors with specific expertise who wish to review pull requests for specific platforms. +- Contributors interested in reviewing [client specification](https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md) updates. + +> [!NOTE] +> This mechanism is purely for automatic review requests for PRs and doesn't grant collaborators additional copyright over the code-owned files. View the [LICENSE](https://github.com/tldr-pages/tldr/blob/main/LICENSE.md) file for more information.