riseproject-dev / riseproject-dev/python-wheels

docs: PRs should only specify the license, not extract from LICENSE files

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

还没有人认领这个 Issue。

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

描述

Some upstream projects point at a license file with the license field in pyproject.toml. This causes our auto docs updates to pull in the entire license file's contents. This has not been a big issue since it isn't common, but it should be fixed so that the workflows/scripts only identify the correct license type and indicate it in the package's doc.

贡献指南

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

从这里开始

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

调研方向

首先定位负责自动更新文档的 workflow 或脚本,并检查它如何从 pyproject.toml 读取 license 字段。使用一个 license 字段指向 LICENSE 文件的 package 验证此更改;当 package 文档能够标识 license 类型且不包含文件的完整内容时,即表示完成。

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

评估

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

把新 issue 发到你的邮箱

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