riseproject-dev / riseproject-dev/python-wheels
docs: PRs should only specify the license, not extract from LICENSE files
オープン
まだ誰も着手していません。
documentation
enhancement
good first issue
infrastructure
- 主要言語
- Python
- スター
- 0
- フォーク
- 0
- 平均マージ
- 16時間 14分
- マージ済み PR（30日）
- 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.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、自動ドキュメント更新を担当する workflow またはスクリプトを見つけ、pyproject.toml からライセンスフィールドをどのように読み取っているかを確認します。ライセンスフィールドが LICENSE ファイルを指しているパッケージで変更を検証します。パッケージのドキュメントがライセンスの種類を特定し、ファイルの全内容を含めていなければ完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation, tooling
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 活発
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 65/100