Skip to content

Commit e0008d3

Browse files
tweak documentation
1 parent 6eeb9c9 commit e0008d3

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,9 @@ All pull requests must include tests to maintain 100% coverage. Coverage configu
127127

128128
Integration tests are contained in the [`tests/integration`](tests/integration) directory and test actual interactions with GitHub's API and webhooks.
129129

130-
These tests are skipped by default and must be explicitly enabled by passing `--integration` as a pytest argument. Running them requires both a GitHub App and a Personal Access Token (PAT) configured in your environment.
130+
These tests are skipped by default and must be explicitly enabled by passing `--integration` as a pytest argument. Running them requires a GitHub App in your user account and configured in your environment.
131131

132-
Follow these steps to set up your environment for integration tests:
132+
Follow these steps to get set up for integration tests:
133133

134134
1. Create a test GitHub App:
135135
- Go to GitHub Developer Settings > GitHub Apps > New GitHub App
@@ -148,7 +148,6 @@ Follow these steps to set up your environment for integration tests:
148148
3. Install the new test GitHub App on your user account by selecting "Install App" from the GitHub App admin panel.
149149
- After installation, make note of the unique ID in the URL, e.g. `https://github.com/settings/installations/<unique ID>`
150150
5. Configure the following environment variables:
151-
152151
- `TEST_ACCOUNT_NAME` - your GitHub username
153152
- `TEST_ACCOUNT_TYPE` - user
154153
- `TEST_APP_ID` - the App ID of the GitHub App from step 2
@@ -174,8 +173,7 @@ After setup, you can run the test suite with the integration tests enabled by pa
174173

175174
```bash
176175
uv run nox --session test -- --integration
177-
# or
178-
just test --integration
176+
# just test --integration
179177
```
180178

181179
## Linting and Formatting

0 commit comments

Comments
 (0)