riseproject-dev / riseproject-dev/python-wheels
docs: clean up field usage
オープン
まだ誰も着手していません。
documentation
enhancement
good first issue
infrastructure
- 主要言語
- Python
- スター
- 0
- フォーク
- 0
- 平均マージ
- 16時間 14分
- マージ済み PR(30日)
- 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:
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 packagewarning- 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 infrastructurepatched- 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:
gpl-sources- specify this with one or more links if we have to provide GPL source tarballs as part of the package buildscomment- anything else (notes about patching, skipping tests, etc.) goes here
@justeph @luhenry thoughts?
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Issue では特定のファイルやテストは指定されていないため、まず現在 comment、warning、patched を使用しているパッケージドキュメントのフィールドを特定します。エントリを移行する前に、提案されたフィールドスキームを確認します。GPL ソースリンクには gpl-sources を使用し、その他の注記には comment を使用してから、古いフィールドの使用が残っていないことを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 活発
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100