Improve methods order
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- リファクタリング
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず SDK クラスとそのメソッドの現在の順序を一覧化し、次に単体テストのメソッドを調べて実装を反映しているかどうかを確認します。何かを変更する前に、想定されるユースケースとワークフローについて committers と話し合います。SDK メソッドが6部構成の順序規約に従い、単体テストが任意でそれに合わせて並べ替えられていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Description
The methods of a class should follow an ordering convention. Currently, all the methods are placed by either their usecase or just randomly in the class. The initial order was first mentioned in this comment, and after a discussion with @christoph-hamm, we decided this should be the final order:
- Class-level attributes
- Constructor (
__init__) - Alternative constructors (usually some class methods)
- Magic methods like
__str__,__len__,__del__etc. - Property methods
- The rest of the methods (public, private, static, class which are not ctor) (mixed together, following the "caller before the callee" rule)
The order should also be added to the DEVELOPMENT.md file, so that it's clear for future development of the SDK.
Goals
The code is refactored and the methods are in a proper order.
Final result
Summary
To be filled when the final solution is sketched.
Tasks
- Reorder the methods in the sdk
- Optional: Reorder the unit test methods to match the implementation
- 主要言語
- Python
- スター
- 9
- フォーク
- 5
- 平均マージ
- 1日 9時間
- マージ済み PR（30日）
- 4
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
eclipse-ankaios/ank-sdk-python のほかの issue
-
python-version
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
-
enhancement good first issue
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
eclipse-ankaios/ank-sdk-python#99 · コメント 1 件 ·
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
eclipse-ankaios/ank-sdk-python の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
sierra-research/tau2-bench#635 ·
メンテナーはふだん 1 日以内に返信
-
The add-ssm-model skill requires a Cython simulator; the contributing guide allows Python ones対応中かも @fmuia が今日担当しました。 オープンdocumentation skill
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
lnccbrown/ssm-simulators#406 ·
メンテナーはふだん 4 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
btclib-org/btclib-ecc#309 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
jbacalso24/mimry#459 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
[Bug] POST /revoke with a FastMCP access token is a silent no-op (ownership gate never matches)オープンauth bug high-priority
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信