react-doctor 0.2.11 → 0.2.12-dev.269ca17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -43,6 +43,32 @@ Works with Claude Code, Cursor, Codex, OpenCode, and many more.
43
43
 
44
44
  Add the reusable GitHub Action from Marketplace to scan every pull request, show inline annotations, and leave findings where reviewers already look.
45
45
 
46
+ ```yaml
47
+ name: React Doctor
48
+
49
+ on:
50
+ pull_request:
51
+ types: [opened, synchronize, reopened, ready_for_review]
52
+
53
+ permissions:
54
+ contents: read
55
+ pull-requests: write
56
+ issues: write
57
+
58
+ concurrency:
59
+ group: react-doctor-${{ github.event.pull_request.number || github.ref }}
60
+ cancel-in-progress: true
61
+
62
+ jobs:
63
+ react-doctor:
64
+ runs-on: ubuntu-latest
65
+ steps:
66
+ - uses: actions/checkout@v5
67
+ - uses: millionco/react-doctor@main
68
+ ```
69
+
70
+ React Doctor scans the files changed in the pull request, emits inline annotations, blocks on error-level findings, and updates one sticky PR comment with the score and issue summary. The built-in GitHub token is used automatically; no secret or PAT is required. On forked PRs where GitHub withholds write permissions, the scan and annotations still run, but the sticky comment may be skipped.
71
+
46
72
  [Add GitHub Action →](https://github.com/marketplace/actions/react-doctor)
47
73
 
48
74
  ## Contributing