Skip to content

Commit fb48e69

Browse files
committed
Document wontfix label in README
1 parent 06e558d commit fb48e69

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,17 @@ If your login flow is more complex—if it requires two-factor authentication, s
148148
149149
---
150150

151+
## Keeping an issue closed with `wontfix`
152+
153+
When the scanner files an issue for an accessibility finding and that same finding turns up again on a later run, it reopens the issue (if you'd closed it) so the barrier doesn't get lost. Sometimes, though, you may want a closed issue to _stay_ closed—for example, if you've decided not to act on a particular finding, or you're tracking the work somewhere else.
154+
155+
To stop the scanner from reopening a closed issue, add the **`wontfix`** label to it. On its next run, the scanner sees the label and skips reopening the issue, leaving it closed.
156+
157+
> [!NOTE]
158+
> The `wontfix` label only affects _reopening_. If you remove the label later, the scanner resumes its normal behavior and will reopen the issue on the next run if the finding is still present.
159+
160+
---
161+
151162
## Configuring GitHub Copilot
152163

153164
The a11y scanner leverages GitHub Copilot coding agent, which can be configured with custom instructions:

0 commit comments

Comments
 (0)