Skip to content
This repository was archived by the owner on Mar 14, 2023. It is now read-only.

Commit 8d4d9f6

Browse files
committed
Adding more details on local dev setup
1 parent 4c6ce3e commit 8d4d9f6

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,22 @@ your local instance. Here is one approach for running a local server:
113113
- Set up the web hook following the instructions in [Enabling a
114114
Repo](#enabling-a-repo), substituting your local Highfive IP address
115115
or domain name and port (if necessary).
116+
- Obtain an OAuth token. In the account you are creating the token in,
117+
go to https://github.com/settings/tokens. Grant access to the repo
118+
scope.
119+
- Put the authorization information obtained in the previous step into
120+
a file named config in the top of the repository (i.e., the
121+
directory containing this file). Here's a template of what it should
122+
look like:
123+
```
124+
[github]
125+
user: OAUTH_TOKEN_USER
126+
token: OAUTH_TOKEN
127+
```
128+
_Do not check in this file or commit your OAuth token to a
129+
repository in any other way. It is a secret._
116130

117-
Here are couple things to watch out for:
131+
Here are some details to be aware of:
118132

119133
- The beginning of `choose_reviewer` in
120134
[highfive/newpr.py](/highfive/newpr.py) contains logic that causes
@@ -124,6 +138,8 @@ Here are couple things to watch out for:
124138
- For Highfive to know how to select reviewers for your repository,
125139
you need a configuration file in
126140
[highfive/configs](/highfive/configs).
141+
- Highfive ignores comments from the integration user near the top of
142+
`new_commment` in [highfive/newpr.py](/highfive/newpr.py).
127143

128144
[rustcontrib]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
129145

0 commit comments

Comments
 (0)