feat: add skills and docs for writing new rules#495
Merged
Conversation
|
✅ No new issues Reviewed by reactreview for commit 928ab91. Configure here. |
Member
|
bugbot run |
There was a problem hiding this comment.
✅ Bugbot reviewed your changes and found no new issues!
Comment @cursor review or bugbot run to trigger another review on this PR
Reviewed by Cursor Bugbot for commit 928ab91. Configure here.
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
96b07cb to
adb4ead
Compare
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Documents the process for creating high-quality React Doctor rules.
The guide gives contributors a concrete workflow for moving from rule idea to implementation, evals, PR description, and review follow-up. It uses PR #491 as the reference example for adversarial testing, RDE workflows, detector scoping, and false-positive review.
What changed
docs/HOW_TO_WRITE_A_RULE.md.Test plan
Not run. Docs-only change.
Made with Cursor
Note
Low Risk
Documentation-only addition with no changes to lint rules, runtime behavior, or dependencies.
Overview
Adds
docs/HOW_TO_WRITE_A_RULE.md, a contributor guide for authoring React Doctor oxlint rules end to end.The doc walks from defining a one-sentence bug and runtime rationale through research, RDE pre- and post-implementation OSS evals, scoping (syntax / scope- / path-aware detectors), adversarial tests, detector implementation, AST vocabulary, naming and utilities, local verification commands, PR description structure, review triage, checklists, and common failure modes. PR #491 (
no-mutating-reducer-state) is the reference example throughout.No runtime or rule code changes—documentation only.
Reviewed by Cursor Bugbot for commit 928ab91. Bugbot is set up for automated code reviews on this repo. Configure here.