line / line/centraldogma-python
Add simple examples to README.md
オープン
まだ誰も着手していません。
documentation
- 主要言語
- Python
- スター
- 21
- フォーク
- 11
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
README.md could be a gentle guide for users to start centraldogma-python for the first time.
Examples:
https://github.com/line/centraldogma-go
https://github.com/line/centraldogma-rs
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
README.md から始め、リンクされている centraldogma-go および centraldogma-rs リポジトリの入門資料を比較します。新しいユーザーが手順を追えるよう十分なコンテキストを含め、Python クライアントの初回利用向けの簡単な例を追加します。README では、初回のセットアップと使用の流れを明確に案内する必要があります。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100