From d708552a0df821b716f58dc4ece2b15899dc1876 Mon Sep 17 00:00:00 2001 From: Alex Ellis Date: Sun, 3 Dec 2017 05:45:28 -0600 Subject: [PATCH] Document in README Signed-off-by: Alex Ellis --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a0e92c2..65e0cb6 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,21 @@ You don't have to give people full write access anymore to help you manage issue * Wait.. doesn't the term "maintainer" mean write access in GitHub? -No - the GitHub UI doesn't use the term maintainer, it speaks of collaborators or team members with write access. Adding someone to a file called maintainers means they have opted to help you maintain the code by helpng curate, triage and chase up issues and PRs. Derek means you no longer have to grant full write-access to let people help you maintain the project. +No this is what Derek sets out to resolve. The users in your maintainers list have granular permissions which you'll see in detail when you add the app to your repo org. + +``` +maintainers: +- alexellis +- rgee0 +``` + +You can use the alias "curators" instead for the exact same behaviour: + +``` +curators: +- alexellis +- rgee0 +``` * What about roles?