From 2db75de8d301f50ae39b8e3c0bfbce5ac6ff7c4d Mon Sep 17 00:00:00 2001 From: Steve Hipwell Date: Thu, 16 Jan 2025 14:58:53 +0000 Subject: [PATCH] chore: Add reviewers file (#3435) --- CONTRIBUTING.md | 23 ++++++++++++++++++++--- REVIEWERS | 1 + 2 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 REVIEWERS diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1fdbef5abe..f8317aa567f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,6 @@ You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again. - ## Reporting issues Bugs, feature requests, and development-related questions should be directed to @@ -28,6 +27,21 @@ how the requested feature would help you do that. Security related bugs can either be reported in the issue tracker, or if they are more sensitive, emailed to . +## Reviewing PRs + +In addition to writing code, community projects also require community +contributions in other ways; one of these is reviewing code contributions. If +you are willing to review PRs please open a PR to add your GitHub username to +the [REVIEWERS](./REVIEWERS) file. By adding your GitHub username to the list +of reviewers you are giving contributors permission to request a review for a +PR that has already been approved by a maintainer. If you are asked to review a +PR and either do not have the time or do not think you are able to you should +feel comfortable politely saying no. + +If at any time you would like to remove your permission to be contacted for a +review you can open a PR to remove your name from the [REVIEWERS](./REVIEWERS) +file. + ## Submitting a patch 1. It's generally best to start by opening a new issue describing the bug or @@ -67,10 +81,14 @@ are more sensitive, emailed to . This is done to make a much cleaner `git log` history and helps to find regressions in the code using existing tools such as `git bisect`. + - If your PR needs additional reviews you can request one of the + [REVIEWERS][] takes a look by mentioning them in a PR comment. + [forking]: https://help.github.com/articles/fork-a-repo [well-formed commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html [pull request]: https://help.github.com/articles/creating-a-pull-request [monitored by codecov.io]: https://codecov.io/gh/google/go-github +[REVIEWERS]: ./REVIEWERS ## Code Comments @@ -195,7 +213,7 @@ section for more information. **script/test.sh** runs tests on all modules. -## Other notes on code organization ## +## Other notes on code organization Currently, everything is defined in the main `github` package, with API methods broken into separate service objects. These services map directly to how @@ -210,7 +228,6 @@ defined at live in [GitHub API documentation]: https://docs.github.com/en/rest [repos_hooks.go]: https://github.com/google/go-github/blob/master/github/repos_hooks.go - ## Maintainer's Guide (These notes are mostly only for people merging in pull requests.) diff --git a/REVIEWERS b/REVIEWERS new file mode 100644 index 00000000000..2dd1f6fe582 --- /dev/null +++ b/REVIEWERS @@ -0,0 +1 @@ +stevehipwell