simvue-io / simvue-io/python-api

Be Consistent in Python API Print Outs

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

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

主要言語
Python
スター
4
フォーク
1
平均マージ
5日 8時間
マージ済み PR（30日）
4

説明

Currently the Python API has two forms of information display:

  • Logging with the built-in logging Python module.
  • Custom printouts which are displayed in colour using click.

The issue here is that logging statements are sent as Events to the server, but these printouts are not.
Discussion needs to be had on how to handle these two cases.

Image

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

調査の方向性

まず、Python API における組み込み logging モジュールの使用箇所と、Click ベースの色付き出力を読みます。どのメッセージが server Events になり、どれがならないかを比較し、その後、完了基準を定義する前に、両方の場合の意図された扱いを明確にします。

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

評価

技術スタック
python
領域
api, backend-api-design
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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