Toolkit 開発 - ベスト プラクティス

Toolkit のコードを扱うときには、いくつかの推奨されるベスト プラクティスがあります。

フック

フックをパイプライン設定(通常 install/apps フォルダにあります)から config/hooks にコピーし、config/env の環境を更新してこれらの新しいフックを参照させます。フックを編集する場合、必要に応じて元の状態に戻るためのバックアップを作成することを推奨します。

構成

また、Git 内のパイプライン設定の config フォルダを管理し、Git ベースのワークフローに従うことを推奨します。したがって、フックは Git でも管理されます。この一元化された設定のコピーは、新しいプロジェクトを構成するときに再利用できます。

たとえば、Shotgun Desktop では、Project Setup Wizard を Git リポジトリにポイントすると、Toolkit はそのリポジトリのクローンを新しいパイプライン設定の config フォルダに作成します。config フォルダはクローン作成された Git リポジトリになるので、一元管理された設定に対してプッシュおよびプルすることができ、パイプライン設定を簡単に更新またはロールバックすることができます。

アプリ

フックが Toolkit の必要な動作を実行するのに十分でない場合、アプリのコードを微調整する必要があります。当社のアプリを GitHub でフォークすることを推奨します。

Shotgun ユーザは、アプリを自由にフォークして、変更をプライベートのリポジトリに保存することができます。当社は、行われた変更を共有し、コミュニティがその変更の恩恵を受けられるようにすることを希望します。またそれによって、当社が更新を行ったときに個人の開発者がアプリのプライベート フォークを維持する手間をなくすことができます。

変更を提出する際は、ツールが幅広いユーザを対象として動作しなければならないことに注意してください。したがって、変更がスタジオに固有のものである場合、より一般的な内容にする必要があります(これについては、推奨事項を提供いたします)。アプリの変更を提案する最善の方法は、スタジオが独自のカスタム機能を実装できる新しいフックを導入し、一方で既存のユーザは既定のフックを元の状態のまま使用できるようにすることです。

最後に、専用のアプリを作成したり、既存のアプリを調整したりする場合は、開発ディスクリプタを使用することを推奨します。これにより、アプリをファイルシステムのどこからでもロードすることができ、Shotgun メニューの[Reload and Restart]エントリを公開して、Maya や Nuke を終了せずにコードを再ロードし、繰り返しの作業を高速化することができます。

フォローする

0 コメント

ログインしてコメントを残してください。