Improve documentation for Attribution
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python, yaml
- 領域
- cli, documentation
調査の方向性
まず ABCTK のドキュメントと transform コマンドのヘルプ出力を見つけます。特に、issue で言及されている --help--format 関数を確認してください。高レベルのドキュメントを Attribution と ABOUT ファイルのセクションに再編成し、attrib と transform を Attribution の下に配置します。ABCTK をインストールしなくても transform の YAML コンテンツがドキュメントで説明されていれば完了です。
索引モデルが 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 ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
aboutcode-org/aboutcode-toolkit のほかの issue
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
-
Update PURLDB with all ABCTK releases再び着手できるかも @pombredanne が 595 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンImportant needs design
aboutcode-org/aboutcode-toolkit#582 · コメント 2 件 · 担当者 3 名 ·
-
Enhance `about_resource` to reference multiple files.再び着手できるかも @chinyeungli が 248 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
aboutcode-org/aboutcode-toolkit#566 · コメント 2 件 · 担当者 1 名 ·
-
Create test file with a few hundred items再び着手できるかも @DennisClark が 1712 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
aboutcode-org/aboutcode-toolkit#491 · 担当者 2 名 ·
-
Clean up / Organize code再び着手できるかも @sahil-MK2 が 1731 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
aboutcode-org/aboutcode-toolkit#483 · コメント 1 件 · 担当者 2 名 ·
aboutcode-org/aboutcode-toolkit の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
namespace operations
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
EclipseFdn/open-vsx.org#15057 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
FinanceFlash/unvibecode#349 ·
-
Mission statement: why this is free, in the README, Why This Exists and the wiki Home対応中かも @ChiefGyk3D が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
ChiefGyk3D/Clouds-Against-Humanity#348 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
vllm-project/vime#508 ·
メンテナーはふだん 4 日以内に返信