docs: add read:user to required token scopes #67

Merged
aweiker merged 1 commits from issue-66 into main 2026-05-11 06:52:22 +00:00
+3 -2
View File
@@ -329,11 +329,12 @@ All flags have environment variable equivalents:
### Token Scopes Required
Review

[NIT] Section title says 'Token Scopes Required' but the table includes an optional scope (read:user). Consider renaming to 'Token Scopes' or splitting into 'Required' and 'Optional' for clarity.

**[NIT]** Section title says 'Token Scopes Required' but the table includes an optional scope (`read:user`). Consider renaming to 'Token Scopes' or splitting into 'Required' and 'Optional' for clarity.
| Scope | Purpose |
|-------|---------|
|-------|--------|
Review

[NIT] The header separator row changed from |-------|---------| to |-------|--------| (one fewer dash in the second column). Both are valid Markdown table syntax, but the inconsistency with the surrounding table style is trivially cosmetic.

**[NIT]** The header separator row changed from `|-------|---------|` to `|-------|--------|` (one fewer dash in the second column). Both are valid Markdown table syntax, but the inconsistency with the surrounding table style is trivially cosmetic.
| `write:issue` | Post and delete reviews |
| `write:repository` | Read PR diffs, file content, commit statuses |
| `read:user` | Self-request as reviewer (optional but recommended) |
No `read:user` scope needed — the bot identifies itself from the review response.
Without `read:user`, the bot still works but cannot add itself to the PR's reviewer list.
## Development