Skip to content

Commit 2db75de

Browse files
authored
chore: Add reviewers file (#3435)
1 parent 6b18a2b commit 2db75de

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed

CONTRIBUTING.md

+20-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ You generally only need to submit a CLA once, so if you've already submitted one
1515
(even if it was for a different project), you probably don't need to do it
1616
again.
1717

18-
1918
## Reporting issues
2019

2120
Bugs, feature requests, and development-related questions should be directed to
@@ -28,6 +27,21 @@ how the requested feature would help you do that.
2827
Security related bugs can either be reported in the issue tracker, or if they
2928
are more sensitive, emailed to <[email protected]>.
3029

30+
## Reviewing PRs
31+
32+
In addition to writing code, community projects also require community
33+
contributions in other ways; one of these is reviewing code contributions. If
34+
you are willing to review PRs please open a PR to add your GitHub username to
35+
the [REVIEWERS](./REVIEWERS) file. By adding your GitHub username to the list
36+
of reviewers you are giving contributors permission to request a review for a
37+
PR that has already been approved by a maintainer. If you are asked to review a
38+
PR and either do not have the time or do not think you are able to you should
39+
feel comfortable politely saying no.
40+
41+
If at any time you would like to remove your permission to be contacted for a
42+
review you can open a PR to remove your name from the [REVIEWERS](./REVIEWERS)
43+
file.
44+
3145
## Submitting a patch
3246

3347
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 <[email protected]>.
6781
This is done to make a much cleaner `git log` history and helps to find regressions in the code
6882
using existing tools such as `git bisect`.
6983

84+
- If your PR needs additional reviews you can request one of the
85+
[REVIEWERS][] takes a look by mentioning them in a PR comment.
86+
7087
[forking]: https://help.github.com/articles/fork-a-repo
7188
[well-formed commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
7289
[pull request]: https://help.github.com/articles/creating-a-pull-request
7390
[monitored by codecov.io]: https://codecov.io/gh/google/go-github
91+
[REVIEWERS]: ./REVIEWERS
7492

7593
## Code Comments
7694

@@ -195,7 +213,7 @@ section for more information.
195213

196214
**script/test.sh** runs tests on all modules.
197215

198-
## Other notes on code organization ##
216+
## Other notes on code organization
199217

200218
Currently, everything is defined in the main `github` package, with API methods
201219
broken into separate service objects. These services map directly to how
@@ -210,7 +228,6 @@ defined at <https://docs.github.com/en/rest/webhooks/repos> live in
210228
[GitHub API documentation]: https://docs.github.com/en/rest
211229
[repos_hooks.go]: https://github.com/google/go-github/blob/master/github/repos_hooks.go
212230

213-
214231
## Maintainer's Guide
215232

216233
(These notes are mostly only for people merging in pull requests.)

REVIEWERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
stevehipwell

0 commit comments

Comments
 (0)