diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0eeabfc..03cfb90 100644 --- 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") +

+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") +

+ 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 new file mode 100644 index 0000000..39a4511 Binary files /dev/null and b/images/developer_settings.png differ diff --git a/images/token.png b/images/token.png new file mode 100644 index 0000000..387d0d6 Binary files /dev/null and b/images/token.png differ