Skip to content

Commit 2df6464

Browse files
hariprakash619lwasser
authored andcommitted
In CONTRIBUTING.md, add more specifics on configuring API token #194
1 parent 0baa154 commit 2df6464

File tree

3 files changed

+13
-0
lines changed

3 files changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,19 @@ pip install -e ".[dev]"
8484
To run this you need to [create a TOKEN that can be used to access the GitHub
8585
API.](https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api?apiVersion=2022-11-28#about-tokens)
8686

87+
In GitHub, click on your profile image and navigate to "Settings", and then
88+
"Developer Settings".
89+
90+
![Image of GitHub Developer Settings page](images/developer_settings.png "Developer Settings page")
91+
<br/><br/>
92+
Create a new fine-grained personal access token, adding a name, expiration,
93+
description, and ensure the "Repository Access" is set to "Public Repositories
94+
(read-only)". No other configuration needed. At the bottom of the page, click
95+
"Generate token".
96+
97+
![Image of personal access token](images/token.png "Token configuration page")
98+
<br/><br/>
99+
87100
After obtaining a token;
88101

89102
1. Duplicate the `.env-default` file and rename the copy to `.env`

images/developer_settings.png

220 KB
Loading

images/token.png

311 KB
Loading

0 commit comments

Comments
 (0)