reactjs / reactjs/react.dev

README Formatting suggestion

未关闭
#2,015 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
JavaScript
星标
11.8k
派生
7.9k
平均合并
1 天 11 小时
30 天内合并 PR
11

描述

The README is comprehensive and helpful, and could be even better served if at the top of the README there was a row of all the major header (perhaps even linked to jump the the part of the page it references), and a description of aforementioned headers so that users could more easily navigate it, especially for newcomers.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先打开仓库的 README,查看其中现有的主要标题和结构。在靠近开头的位置添加一行包含这些标题及简短描述的链接,然后验证每个链接都会跳转到预期的部分,并确保 README 对新手来说仍然易于阅读。

由索引模型根据 Issue 内容生成。

评估

领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。