跳转到主要内容

贡献指南

本页描述贡献流程的最小闭环:你提交什么、如何评审、如何保证长期可维护。

技术文章规范(v1)

目标不是“写更多”,而是让每一页都可验证地有用:读者能预测行为、知道边界,并避开常见坑。

  • TL;DR 开头:3–6 条直接写清核心契约与最大坑。
  • 写清不变量:React 保证什么、不保证什么。
  • 用机制解释而不是口号:讲清为什么有效,而不只是怎么写。
  • 至少给一个反例:常见误用是什么、怎么修。
  • 补齐链接闭环:Learn → Guides → Reference → Explanation。

“标杆深度内容”判定标准

标杆不是“写得长”,而是“让读者更正确”。新增/评审深挖内容时,按下面标准自检。

  • 先写契约:TL;DR 一眼写清“保证 / 不保证 / 最大坑”,让读者立刻知道边界。
  • 用机制解释:为什么这套写法有效?依赖哪些不变量?哪些前置条件不满足就会失效?
  • 反例驱动:至少给 1 个最常见的误用版本,并给出可复现的修复路径。
  • 可落地:给出“怎么放边界/什么时候用不用/上线怎么自检”的决策准则,而不只是 API 罗列。
  • 补齐链接闭环:把 Learn → Guides → Reference → Explanation 串起来,便于验证与加深。
  • 用可验证表述:避免“听起来对但不精确”的断言;若依赖框架/缓存/运行环境,必须写清前置条件。
贡献指南 - Community - React 文档 - React 文档