Generate a CLI reference page

オープン 初心者向け
  • 何か問題がありますか？
#66 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
88/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
github-actions, python
領域
ci-cd, cli, documentation

調査の方向性

src/meridian/cli.pyと、issueに示されているTyperのドキュメント生成コマンドから始めて、アプリがコマンドとオプションをどのように公開しているかを確認します。docs/cli.mdを生成し、READMEからリンクし、参照が最新であることを検証するCIチェックを追加します。ページにすべてのコマンドとオプションが記載され、CIで検証されれば完了です。

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

説明

area: cli area: docs documentation good first issue size: S
Context

Command options are only discoverable through --help.

What to do

Generate docs/cli.md from the Typer app (for example with typer meridian.cli utils docs) and add a CI check that it is current.

Done when

docs/cli.md lists every command and option and is linked from the README.

Where to look

src/meridian/cli.py

New here? Read CONTRIBUTING.md and comment on this issue to say you are taking it.

Generated by Claude Code

主要言語
Python
スター
0
フォーク
0
平均マージ
2時間 13分
マージ済み PR（30日）
19

環境構築

はじめの一歩

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

patsypppe/meridian のほかの issue

patsypppe/meridian の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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