Add complete example/docs on adding traits and specifications
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
メインの API オリエンテーション ドキュメントと、issue #946 で追跡されているフォーマットの決定から始めます。パッケージ間の trait 参照を含むホスト固有の YAML 例、基本的な CLI 生成および Python の使用例、さらにベストプラクティスに関する警告を追加します。完了とは、対象範囲として列挙されたすべてのセクションが、CI、詳細な使用方法、または C++ の内容を追加せずに文書化されていることを意味します。
索引モデルが issue の本文から書いたものです。
説明
What
Properly document the process of adding custom traits + specifications to a Host, so we have good examples of the ideas, process and resulting YAML, including cross-package references (eg. back to MediaCreation)
ACs
- Example of adding host-specific specifications following on from a link to the main API docs.
- Pointers to API orientation docs
- Worked YAML authoring example with cross-package trait references
- Basic CLI generation
- Basic usage example (python)
- Calls out best practices and "dont do this" in appropriate sections.
- Format TBD in https://github.com/OpenAssetIO/OpenAssetIO/issues/946
Out of scope
- CI/build system integration
- In-depth usage examples
- C++
- 主要言語
- Python
- スター
- 7
- フォーク
- 7
- 平均マージ
- 1時間 7分
- マージ済み PR（30日）
- 1
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
OpenAssetIO/OpenAssetIO-TraitGen のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 38/100
OpenAssetIO/OpenAssetIO-TraitGen#123 · コメント 2 件 ·
-
good first issue
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
OpenAssetIO/OpenAssetIO-TraitGen#93 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
OpenAssetIO/OpenAssetIO-TraitGen#84 · コメント 2 件 ·
-
breaking change risk
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
OpenAssetIO/OpenAssetIO-TraitGen の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
With emit_ontology_keys, one ontology key change is reported as two errors (keys and keys_digest)対応中かも @rvandewater が今日担当しました。 オープンbug priority:low
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
難易度 1/5 1〜3時間 初心者へのやさしさ 84/100
iausathub/satchecker#286 ·
メンテナーはふだん 1 日以内に返信
-
bug test
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
OpenAssetIO/OpenAssetIO#1527 ·
-
automated endpoint-dead needs-curation
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
almanac-data/climate-almanac#128 ·
メンテナーはふだん 1 日以内に返信