@@ -15,7 +15,6 @@ You generally only need to submit a CLA once, so if you've already submitted one
15
15
(even if it was for a different project), you probably don't need to do it
16
16
again.
17
17
18
-
19
18
## Reporting issues
20
19
21
20
Bugs, feature requests, and development-related questions should be directed to
@@ -28,6 +27,21 @@ how the requested feature would help you do that.
28
27
Security related bugs can either be reported in the issue tracker, or if they
29
28
are more sensitive, emailed to
< [email protected] > .
30
29
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
+
31
45
## Submitting a patch
32
46
33
47
1 . It's generally best to start by opening a new issue describing the bug or
67
81
This is done to make a much cleaner ` git log ` history and helps to find regressions in the code
68
82
using existing tools such as ` git bisect ` .
69
83
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
+
70
87
[ forking ] : https://help.github.com/articles/fork-a-repo
71
88
[ well-formed commit messages ] : http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
72
89
[ pull request ] : https://help.github.com/articles/creating-a-pull-request
73
90
[ monitored by codecov.io ] : https://codecov.io/gh/google/go-github
91
+ [ REVIEWERS ] : ./REVIEWERS
74
92
75
93
## Code Comments
76
94
@@ -195,7 +213,7 @@ section for more information.
195
213
196
214
** script/test.sh** runs tests on all modules.
197
215
198
- ## Other notes on code organization ##
216
+ ## Other notes on code organization
199
217
200
218
Currently, everything is defined in the main ` github ` package, with API methods
201
219
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
210
228
[ GitHub API documentation ] : https://docs.github.com/en/rest
211
229
[ repos_hooks.go ] : https://github.com/google/go-github/blob/master/github/repos_hooks.go
212
230
213
-
214
231
## Maintainer's Guide
215
232
216
233
(These notes are mostly only for people merging in pull requests.)
0 commit comments