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
-
FEATURE REQUEST
难度 2/5 1-3 小时 新手友好度 68/100
linuxmint/cinnamon-spices-extensions#1193 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 76/100
Fei2411/DeepSeek-Bot#703 ·
-
area:web first-timers-only good first issue
难度 1/5 1 小时以内 新手友好度 95/100
career-ops-hq/career-ops#6264 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 83/100
cline/mcp-marketplace#3394 ·
-
bug
难度 2/5 1-3 小时 新手友好度 77/100
exelearning/exelearning#2677 ·
维护者通常 1 天内回复