riseproject-dev / riseproject-dev/python-wheels

docs: clean up field usage

未关闭
#386 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

documentation enhancement good first issue infrastructure
主要语言
Python
星标
0
派生
0
平均合并
16 小时 14 分钟
30 天内合并 PR
952

描述

We currently have a mixture of several fields in our package docs. Between historic patterns and new workflows, each package may feature one or more of:

  1. comment - a generic field for providing commentary on a package. This was previously always used to provide a link to a GPL sources tarball if required for a package
  2. warning - usually used to indicate we've had to skip some sort of test or omit a piece of functionality in a module, due to incompatibility or known issues with riscv64 or our infrastructure
  3. patched - a typically blank field used to signal that the package is built with one or more patches applied during the process

These are all somewhat redundant. I propose two to replace these:

  1. gpl-sources - specify this with one or more links if we have to provide GPL source tarballs as part of the package builds
  2. comment - anything else (notes about patching, skipping tests, etc.) goes here

@justeph @luhenry thoughts?

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

该 issue 未指定具体的文件或测试;首先定位目前使用 comment、warning 和 patched 的 package 文档字段。在迁移条目之前,确认建议的字段方案:使用 gpl-sources 表示 GPL 源代码链接,使用 comment 表示其他备注,然后验证不再存在旧字段的使用情况。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
活跃
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。