Great README examples (documentation, markdown)
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- markdown
研究方向
先檢視 repository 目前的 README,並與 issue 中連結的範例進行比對。issue 未指定目標檔案、具體變更或驗收標準,因此請在開始前定義 README 的範圍,以及一份可衡量的完成檢查清單。
由索引模型根據 Issue 內容生成。
描述
What should a README be?
Projects should have READMEs that have
- Easy to understand the purpose
- At-a-glance visual usage / demo
- Actual demo
- Easy deploy instructions
Great READMEs
Master Markdown
(honestly, it's easy)
- 主要語言
- JavaScript
- 星號
- 63
- 分支
- 3
- PR 合併指標
- 30 天內沒有已合併 PR
貢獻指南
這個儲存庫沒有索引到貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
BeyondCodeBootcamp/beyondcodebootcamp 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 25/100
BeyondCodeBootcamp/beyondcodebootcamp#22 · 1 個 reaction ·
-
難度 5/5 一週以上 新手友好度 25/100
BeyondCodeBootcamp/beyondcodebootcamp#21 · 1 則留言 ·
-
難度 2/5 1-3 小時 新手友好度 30/100
-
難度 3/5 1-2 天 新手友好度 35/100
BeyondCodeBootcamp/beyondcodebootcamp#19 · 1 個 reaction ·
-
BeyondCodeBootcamp/beyondcodebootcamp#18 · 20 則留言 · 7 個 reaction · 已指派 1 人 ·
查看 BeyondCodeBootcamp/beyondcodebootcamp 的全部 Issue
相似的 Issue
-
Bug
難度 2/5 1-3 小時 新手友好度 70/100
Automattic/safe-publish#594 ·
-
難度 2/5 1-3 小時 新手友好度 75/100
dream-num/dsh-univer-office#104 ·
-
comp/dashboard invalid P3
難度 2/5 1-3 小時 新手友好度 70/100
NousResearch/hermes-agent#121143 ·
-
難度 2/5 1-3 小時 新手友好度 75/100
avniproject/avni-webapp#1811 ·
-
area/auroraboot area/webui bug
難度 2/5 1-3 小時 新手友好度 75/100