In CONTRIBUTING.md, add more specifics on configuring API token #194

pyOpenSci · Feb 13, 2025 · 2df6464 · 2df6464
1 parent 0baa154
commit 2df6464
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -84,6 +84,19 @@ pip install -e ".[dev]"
 To run this you need to [create a TOKEN that can be used to access the GitHub
 API.](https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api?apiVersion=2022-11-28#about-tokens)
 
+In GitHub, click on your profile image and navigate to "Settings", and then
+"Developer Settings".
+
+![Image of GitHub Developer Settings page](images/developer_settings.png "Developer Settings page")
+<br/><br/>
+Create a new fine-grained personal access token, adding a name, expiration,
+description, and ensure the "Repository Access" is set to "Public Repositories
+(read-only)". No other configuration needed. At the bottom of the page, click
+"Generate token".
+
+![Image of personal access token](images/token.png "Token configuration page")
+<br/><br/>
+
 After obtaining a token;
 
 1. Duplicate the `.env-default` file and rename the copy to `.env`

diff --git a/images/developer_settings.png b/images/developer_settings.png
diff --git a/images/token.png b/images/token.png