diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..75650ce --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# Contributing to this repo + +## Setup + +### Personal access token (PAT) + +Follow [these](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) instructions to configurate a personal access token. + +Only permissions needed: +- public_repo + +Save the token to a secure location. Click the "Configure SSO" button and "Authorize" if applicable. + +### Config + +```shell +cp config.example.json config.json + +# Add your GitHub username and token +$EDITOR config.json + +# Export the JSON credentials into an environment variable +export CONFIG=$(