Create guidelines for README Files
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 30/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- markdown
研究方向
首先檢視儲存庫的 README 檔案及其 Docusaurus/Markdown 結構，然後將其與相關的社群最佳實務進行比較。定義標準化的 README 結構並記錄指南，以確保所有 AboutCode 專案中的重要資訊保持一致。
由索引模型根據 Issue 內容生成。
描述
Create a standardized structure for README files across AboutCode projects, aligning with community best practices. By developing a consistent format, we can enhance clarity, improve user onboarding, and ensure that essential information is easily accessible.
- 主要語言
- JavaScript
- 星號
- 9
- 分支
- 17
- 平均合併
- 7 小時 55 分鐘
- 30 天內合併 PR
- 2
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南，環境需要你自己搭建：先看它的 README，通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
aboutcode-org/www.aboutcode.org 的其他 Issue
-
Making all post button.可能已有人在做 @sarthaklole 於 70 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
aboutcode-org/www.aboutcode.org#117 · 3 則留言 ·
-
WWW: Reduce frequency of update-releases可能重新可做 @johnmhoran 於 51 天前認領，目前沒有進行中的 PR。 未關閉ci-workflow
難度 2/5 1-3 小時 新手友好度 45/100
aboutcode-org/www.aboutcode.org#180 · 已指派 1 人 ·
-
DOCS: Create new AboutCode stack diagram(s)可能重新可做 @hixvikas 於 53 天前認領，目前沒有進行中的 PR。 未關閉documentation
難度 5/5 一週以上 新手友好度 35/100
aboutcode-org/www.aboutcode.org#166 · 1 則留言 ·
-
WWW: Create About top level page?可能已有人在做 @pombredanne 於 154 天前認領。 未關閉website
難度 2/5 1-3 小時 新手友好度 35/100
aboutcode-org/www.aboutcode.org#164 · 1 個 reaction · 已指派 1 人 ·
-
WWW: Add Initiatives and grant Projects可能重新可做 @mjherzog 於 241 天前認領，目前沒有進行中的 PR。 未關閉enhancement needs design website
難度 5/5 一週以上 新手友好度 25/100
aboutcode-org/www.aboutcode.org#141 · 已指派 1 人 ·
查看 aboutcode-org/www.aboutcode.org 的全部 Issue
相似的 Issue
-
[guide] AGENTS.md claims the coverage gate, e2e and full lint run on every PR after ADR 0011 focused validation可能已有人在做 @hivecommons-hive 今天認領。 未關閉agent/guide documentation hive/claimed-by-guide stage/040-covered-by-pr
難度 2/5 1-3 小時 新手友好度 81/100
維護者通常 1 天內回覆
-
check:passed feeds:add
難度 2/5 1-3 小時 新手友好度 65/100
維護者通常 4 天內回覆
-
難度 2/5 1-3 小時 新手友好度 78/100
all-contributors/cli#587 ·
維護者通常 1 天內回覆
-
RGAA5
難度 2/5 1-3 小時 新手友好度 66/100
維護者通常 8 天內回覆
-
feedback simulation workshop
難度 2/5 1-3 小時 新手友好度 65/100
githubnext/gh-aw-workshop#5157 ·
維護者通常 1 天內回覆