Skip to content

Document PR dashboard guidance comment #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maryliag merged 1 commit into from
Jun 25, 2026
+9 −83
Merged

Document PR dashboard guidance comment #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 0 additions & 83 deletions .github/scripts/pull-request-dashboard/README.md
View file
Open in desktop

This file was deleted.

9 changes: 9 additions & 0 deletions pull-request-dashboard/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ Ask a maintainer or admin to add the repo to the list of repositories under [Rep

Once the PR is merged, the dashboard will pick up your repository on its next scheduled run. To manually trigger it sooner, see [Manual runs](#manual-runs) below. The dashboard issue is discovered dynamically in your repository by the `dashboard` label and `Pull Request Dashboard` title — if it does not exist, the publish step creates the label and issue.

## One-time PR guidance comment

After the dashboard issue exists, the workflow adds one guidance comment to a
PR the first time a submitted review includes inline comments. A hidden marker
prevents repeat comments on later reviews or workflow runs.

The comment asks authors to give each review thread a clear outcome. This keeps
the dashboard from treating stale or ambiguous threads as the wrong next action.

## Configuration

The target repository GitHub App is installed on each configured repository.
Expand Down