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

Commit be72156

Browse files
authored
Merge pull request #121 from davidalber/more-dev-setup-instructions
Adding more details on local dev setup
2 parents 2ed1083 + 8d4d9f6 commit be72156

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
@@ -123,8 +123,22 @@ your local instance. Here is one approach for running a local server:
123123
- Set up the web hook following the instructions in [Enabling a
124124
Repo](#enabling-a-repo), substituting your local Highfive IP address
125125
or domain name and port (if necessary).
126+
- Obtain an OAuth token. In the account you are creating the token in,
127+
go to https://github.com/settings/tokens. Grant access to the repo
128+
scope.
129+
- Put the authorization information obtained in the previous step into
130+
a file named config in the top of the repository (i.e., the
131+
directory containing this file). Here's a template of what it should
132+
look like:
133+
```
134+
[github]
135+
user: OAUTH_TOKEN_USER
136+
token: OAUTH_TOKEN
137+
```
138+
_Do not check in this file or commit your OAuth token to a
139+
repository in any other way. It is a secret._
126140

127-
Here are couple things to watch out for:
141+
Here are some details to be aware of:
128142

129143
- The beginning of `choose_reviewer` in
130144
[highfive/newpr.py](/highfive/newpr.py) contains logic that causes
@@ -134,6 +148,8 @@ Here are couple things to watch out for:
134148
- For Highfive to know how to select reviewers for your repository,
135149
you need a configuration file in
136150
[highfive/configs](/highfive/configs).
151+
- Highfive ignores comments from the integration user near the top of
152+
`new_commment` in [highfive/newpr.py](/highfive/newpr.py).
137153

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

0 commit comments

Comments
 (0)