React Docs With Scope

When adding or updating React documentation, include usage-scoped, actionable guidance—not just headings. Apply this checklist: - **Purpose (what it is):** Start with a plain-language definition.

copy reviewer prompt

Prompt

Reviewer Prompt

When adding or updating React documentation, include usage-scoped, actionable guidance—not just headings.

Apply this checklist:

  • Purpose (what it is): Start with a plain-language definition.
  • Why/impact (so what): Explain the practical effect (e.g., performance/re-render behavior).
  • Scope/boundaries (when not to use): Explicitly state where it belongs and who should/shouldn’t import/use it.
  • Authoritative resources: Link to official React documentation plus 1–2 reputable deep dives.
  • Markdown hygiene: Ensure the file is well-formed (e.g., end with a newline).

Example (pattern):

`someHook` is a React hook that ...

Use it to ...
Avoid using it when ...

Resources:
- React docs: https://react.dev/... 
- More: https://...

Source discussions