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 摘要。