DOCS: Create standard for format and structure of top-level project files across AboutCode repos
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 35/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- markdown
研究方向
先比較 dejacode、purldb、scancode.io、scancode-toolkit 和 vulnerablecode 中列出的頂層檔案。該 issue 指出立即目標：將 dejacode 和 scancode.io 中的 RELEASE.md 轉換為 rST，將 apache-2.0.LICENSE 檔案重新命名為 LICENSE，並記錄新 AboutCode 儲存庫的標準。檔案命名／格式慣例已套用或明確記錄，即視為完成，但該 issue 已經很舊，而且涉及多個儲存庫。
由索引模型根據 Issue 內容生成。
描述
In most AboutCode repos we have a set of top-level project files including:
- AUTHORS.rst
- CHANGELOG.rst
- CODE_OF_CONDUCT.rst
- CONTRIBUTING.rst
- LICENSE
- NOTICE
- README.rst
- RELEASE.md (dejacode and scancode.io)
- ROADMAP.rst
I looked at dejacode, purldb, scancode.io. scancode-toolkit and vulnerablecode as the primary examples
Although the GitHub norm is for the these files to be in markdown format we are using rST in most cases so the cost/effort to move to markdown does not make sense at this time.
For the LICENSE and NOTICE files we have a mixed bag:
- dejacode: LICENSE file but no NOTICE (makes sense for AGPL-3.0 vs Apache-2.0)
- purldb: NOTICE file plus apache-2.0.LICENSE and cc-by-sa-4.0.LICENSE
- scancode.io: LICENSE and NOTICE files - this should be the pattern for all projects licensed under Apache-2.0)
- scancode-tookit: NOTICE file plus apache-2.0.LICENSE and cc-by-4.0.LICENSE
- vulnerablecode: NOTICE file plus apache-2.0.LICENSE and cc-by-sa-4.0.LICENSE
If you have a top-level file named LICENSE GitHub displays the license name in a "tab" at the top of the README. Using LICENSE as the file suffix does not seem to mean anything to GitHub.
The issue here is to standardize the format and structure of these files across repos and document it for new projects/repos. Some immediate action items include:
- Convert RELEASE.md files to rST for dejacode and scancode.io (this should be easy since these are small chunks of text)
- Rename apache-2.0.LICENSE files to LICENSE.
- 主要語言
- 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 於 52 天前認領，目前沒有進行中的 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
-
step.duration reflects only the last retry attempt (HelperStep.run() overwrites startTime)可能已有人在做 @mirao 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 78/100
codeceptjs/CodeceptJS#5774 · 1 則留言 ·
維護者通常 2 天內回覆
-
Status: Unconfirmed
難度 1/5 1-3 小時 新手友好度 76/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 68/100
AllTheMods/ATM10-Aeronautics#151 ·
維護者通常 4 天內回覆
-
難度 2/5 1-3 小時 新手友好度 82/100
feimacode/open-design-agent-kit#66 ·
維護者通常 1 天內回覆