[Task] Improve comments in the final XML files generated by tutorials
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- xml
調査の方向性
各チュートリアルで公開されている最終的な XML ファイルを見つけ、その構造を定義しているチュートリアルのソースと比較してください。コンテキストと構造上の選択を説明するコメントを追加し、そのコメントがチュートリアルを正確に反映していること、またすべての最終 XML 例が引き続き有効であることを確認してください。
索引モデルが issue の本文から書いたものです。
説明
What is this task about?
We publish XML files that represent the end state of each tutorial. Those files don't provide any context for why the file is structured the way it is, where that context is defined by the tutorials themselves.
Why is this task needed?
Some users don't go through the tutorials so don't have the context, and may be confused by the examples.
How can this issue be closed?
Add comments to the XML files that provide context and describe some of the reasons that the file is structured as it is including various choices.
- 主要言語
- Python
- スター
- 8
- フォーク
- 33
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
cyclus/cyclus.github.com のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
cyclus/cyclus.github.com#454 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 64/100
cyclus/cyclus.github.com#453 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
cyclus/cyclus.github.com#448 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
cyclus/cyclus.github.com#445 ·
-
[Task] Update tutorial files in Zenodo Object再び着手できるかも @connor-welch が 265 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン0 - Backlog
cyclus/cyclus.github.com#441 · コメント 3 件 · 担当者 1 名 ·
cyclus/cyclus.github.com の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
MystenLabs/MemWal#1163 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
infertopics leaves new nodes without a topic when untopiced neighbours outnumber topiced ones対応中かも @moneebullah25 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
FinanceFlash/unvibecode#218 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
NVIDIA/earth2studio#1241 ·
メンテナーはふだん 3 日以内に返信