pr について
Remotion のプルリクエスト作成と提出を支援するリポジトリ向けスキルです。ブランチと PR の確認、フォーマット、ビルドとスタイル検証、コミット、ドキュメントのプレビューリンクを扱います。
主な機能
- 01ブランチと既存 PR の状態確認
- 02変更対象ファイルのみフォーマット
- 03ビルドとスタイルチェックの実行
- 04変更のコミットとプッシュ
- 05変更したドキュメントへのプレビューリンク追加
活用シーン
- 01Remotion の変更をレビュー用に準備
- 02既存ブランチのプルリクエスト更新
- 03変更したドキュメントページへのプレビューリンク設定
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ remotion-dev/ remotion --skill prインストール後、Claude Code で/prを入力して読み込まれたか確認します。
詳細
メインブランチにいないことを確認し、必要であればブランチを作成します。
現在のブランチに対する PR がすでに存在するか、gh pr status または gh pr view で確認します。存在する場合は、ローカルの変更で更新します。
ユーザーから明示的に依頼されていない限り、新しいテストケースを既存ファイルに追加する場合も含め、エージェントが作成した新しいテストは PR に含めないでください。変更に必要な場合は、既存のテスト、フィクスチャ、スナップショットを更新してかまいません。差分を確認し、既存のユーザー変更を保持してください。
変更によって Remotion Element を追加する場合は、続行する前にElement contribution guideを読んでください。
現在の変更の影響を受けるファイルまたはパッケージディレクトリに対して Oxfmt を実行します。実際のパスを指定してください。リポジトリのルートに src ディレクトリがあると決めつけないでください。関連するルートレベルのファイルも含め、無関係なパッケージやリポジトリ全体はフォーマットしないでください。
例:
bunx oxfmt <changed-file-or-package-directory>... --write
変更したファイルのうち Oxfmt がサポートするものがない場合は、この手順を省略してください。コミットする前に、フォーマッターによる変更を確認してください。
次に、次を実行します。
bun run build
bun run stylecheck
これにより、コンパイルと CI の lint/フォーマットが通ることを確認します。
変更は一度だけコミットします。PR のタイトルは pr-name スキルに従ってください。
git push -u origin HEAD を使用して、変更をリモートブランチに一度だけプッシュします。
ユーザーから依頼されない限り、強制プッシュはしないでください。
gh CLI を使用してプルリクエストを作成し、タイトルには上記と同じ形式を使用してください。
PR を作成する際は、シェルコマンドに PR の本文を直接渡さないでください(たとえば、--body "..." や bash のヒアドキュメントは使用しないでください)。代わりに、次の手順に従います。
- システムの一時ディレクトリに一時的な Markdown ファイルとして PR の本文を書き込みます(例:
/tmp/remotion-pr-body.md、または/tmp内に一意の名前で作成したファイル)。- 現在の作業が GitHub の Issue から始まったもの、その修正、またはその他の関連作業である場合は、
Closes #1234やCloses https://github.com/owner/repo/issues/1234などのクローズキーワードを PR の本文に含めます。ユーザーが元の依頼で Issue 番号または URL を提示している場合は、それを保持してください。
- 現在の作業が GitHub の Issue から始まったもの、その修正、またはその他の関連作業である場合は、
gh pr create --title "<title>" --body-file <path-to-temp-md-file>で PR を作成します。
例:
gh pr create --title '`@remotion/package`: Add feature' --body-file /tmp/remotion-pr-body.md
変更されたウェブサイトのページに直接リンクする
PR の作成後、packages/docs 内の主要ページを直接追加または変更しているか確認します。ページのソースをもとに、各ページの公開パスを特定してください。ルートの情報源として packages/docs/docusaurus.config.ts を使用します。削除されたページや、共有コンポーネント、スタイル、データ、設定のみの変更からパスを推測しないでください。
PR の作成後、Vercel のコメントが見つかるまで最大 60 秒間、5 秒おきにコメントを確認します。remotion プロジェクトの行にある Preview リンクを取得し、各ページのパスを追加します。bugs プロジェクトの行は無視してください。プレビューリンクが利用できず、デプロイリンクが Vercel ダッシュボードのみを指している場合は、Vercel CLI がインストール済みで認証されている場合に限り、vercel inspect <deployment-url> を使用します。それ以外の場合は、PR の本文を変更せず、プレビュー URL を特定できなかったことを報告してください。
Vercel のコメントだけを待ってください。デプロイの完了を待ったり、Vercel heartbeat を作成したり、プレビューページにアクセスして確認したりしないでください。
PR の本文に ## Preview セクションを追加し、その下にディープリンクを記載します。現在の本文を一時的な Markdown ファイルに取得し、gh pr edit <pr> --body-file <path-to-temp-md-file> で更新してください。置き換える本文をコマンドに直接渡してはいけません。
ページのパスまたはプレビュー URLを確実に特定できない場合は、作成した PR を変更せず、プレビューリンクを追加しなかったことを報告してください。