Improve documentation for Attribution
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python, yaml
- 领域
- cli, documentation
调研方向
首先定位 ABCTK 文档以及 transform 命令的帮助输出，尤其是 issue 中提到的 --help--format 函数。将高层文档重新组织为 Attribution 和 ABOUT 文件两个部分，并将 attrib 和 transform 放在 Attribution 下。完成的标准是：文档中解释了 transform 的 YAML 内容，且不要求安装 ABCTK。
由索引模型根据 Issue 内容生成。
描述
Within the ABCTK documentation, we should make a distinction between the features and functions that operate on ABOUT files and those that do not require ABOUT files - namely Attribution. This means that we should organized the documentation at a high level under either Attribution or ABOUT files. The attrib and transform commands would be under Attribution and the rest under ABOUT files.
We also need a much more detailed explanation of the content of the transform yaml files - this could just be a copy of the help text from the --help--format function. We do not want to required someone to install ABCTK just to understand how the transform can work.
- 主要语言
- Python
- 星标
- 100
- 派生
- 48
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
aboutcode-org/aboutcode-toolkit 的其他 Issue
-
难度 5/5 一周以上 新手友好度 25/100
-
Update PURLDB with all ABCTK releases可能重新可做 @pombredanne 于 597 天前认领，目前没有进行中的 PR。 未关闭Important needs design
aboutcode-org/aboutcode-toolkit#582 · 2 条评论 · 已指派 3 人 ·
-
Enhance `about_resource` to reference multiple files.可能重新可做 @chinyeungli 于 250 天前认领，目前没有进行中的 PR。 未关闭
aboutcode-org/aboutcode-toolkit#566 · 2 条评论 · 已指派 1 人 ·
-
Create test file with a few hundred items可能重新可做 @DennisClark 于 1714 天前认领，目前没有进行中的 PR。 未关闭
aboutcode-org/aboutcode-toolkit#491 · 已指派 2 人 ·
-
Clean up / Organize code可能重新可做 @sahil-MK2 于 1733 天前认领，目前没有进行中的 PR。 未关闭
aboutcode-org/aboutcode-toolkit#483 · 1 条评论 · 已指派 2 人 ·
查看 aboutcode-org/aboutcode-toolkit 的全部 Issue
相似的 Issue
-
question
难度 2/5 1-3 小时 新手友好度 62/100
conda-forge/vc-feedstock#132 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
limitlessprojects/Go-Hybrid#3342 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
UKGovernmentBEIS/inspect_ai#6268 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
LSSTDESC/rail_sompz#42 ·
-
难度 2/5 1-3 小时 新手友好度 66/100
pytest-dev/pytest-forked#113 ·