Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Reduce CML with DVC report generation code

オープン
#409 コメント 0 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
github, gitlab, markdown, typescript, yaml
領域
documentation

調査の方向性

cml.dev/doc/cml-with-dvc ページから始め、GitHub と GitLab の YAML 例を比較してください。レポートステップの提案された配置、DVCLive と cml pr の例、および Studio のリファレンスを確認してください。導入例がより短くなり、関連するワークフローが明確にドキュメント化されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

C: guide documentation external-request p1-important

Related to #389.

In https://cml.dev/doc/cml-with-dvc, the "Create CML report" step is more than half the YAML file for both GH and GL. I think it's a useful example but makes CML<>DVC integration look way more intimidating than it needs to be.

Some initial ideas for improvement:

  1. Move that step to a separate section further down the page to keep the intro example more concise.
  2. Show a DVCLive example, which will generate the markdown report on its own. Also, should the CML<>DVCLive live update workflow be documented somewhere in this page?
  3. Use cml pr and mention that you can view DVC metrics and plots in Studio (related: https://github.com/iterative/studio/issues/4232).
主要言語
TypeScript
スター
13
フォーク
22
PR マージ指標
30日以内にマージされた PR はありません

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

iterative/cml.dev のほかの issue

iterative/cml.dev の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。