Merge pull request #115 from github/docs-and-fixes

Docs, Fixes, and Updates

Author: GrantBirki

.gitattributes

@@ -1 +1 @@
-dist/** -diff linguist-generated=true 
+dist/** -diff linguist-generated=true

.github/workflows/package-check.yml

@@ -18,7 +18,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: setup node
-        uses: actions/setup-node@v3.8.1
+        uses: actions/setup-node@v4
         with:
           node-version-file: .node-version
           cache: 'npm'

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-## Contributing
+# Contributing
 
 [fork]: https://github.com/github/privileged-requester/fork
 [pr]: https://github.com/github/privileged-requester/compare

README.md

@@ -1,6 +1,6 @@
 # Privileged Requester
 
-[![CodeQL](https://github.com/github/privileged-requester/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/github/privileged-requester/actions/workflows/codeql-analysis.yml) [![package-check](https://github.com/github/privileged-requester/actions/workflows/package-check.yml/badge.svg)](https://github.com/github/privileged-requester/actions/workflows/package-check.yml) [![units-test](https://github.com/github/privileged-requester/actions/workflows/test.yml/badge.svg)](https://github.com/github/privileged-requester/actions/workflows/test.yml) [![privileged-requester](https://github.com/github/privileged-requester/actions/workflows/privileged-requester.yml/badge.svg)](https://github.com/github/privileged-requester/actions/workflows/privileged-requester.yml)
+[![CodeQL](https://github.com/github/privileged-requester/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/github/privileged-requester/actions/workflows/codeql-analysis.yml) [![package-check](https://github.com/github/privileged-requester/actions/workflows/package-check.yml/badge.svg)](https://github.com/github/privileged-requester/actions/workflows/package-check.yml) [![units-test](https://github.com/github/privileged-requester/actions/workflows/test.yml/badge.svg)](https://github.com/github/privileged-requester/actions/workflows/test.yml)
 
 This GitHub Action will automatically approve pull requests based off of requester criteria defined in the target repository.
 
@@ -90,3 +90,20 @@ Here are the configuration options for this Action:
 ## First Time Setup
 
 It should be noted that this Action looks at the `default` branch for its configuration file. This means that if you add this Action through a pull request, it will look at the default branch and _fail_ because it cannot find the config file that has not landed on `main` / `master` yet. After merging the pull request that adds this Action to your repository, it should work as expected.
+
+## GitHub App Permissions
+
+If you are using a GitHub app with this Action, you will need to grant the following permissions:
+
+- Checks: `Read and write`
+- Contents: `Read and write`
+- Metadata: `Read-only`
+- Pull requests: `Read and write`
+
+### Subscribe to Events
+
+This GitHub App will subscribe to the following events:
+
+- Check suite
+- Check run
+- Pull request