| name | review |
| description | 変更のレビューをするためのスキル。「レビューして」や「レビューしてほしい」といった指示で呼び出される。 |
レビューのステップ
1. 静的検査が通るか確かめる
- 変更されたコードが静的検査を通るかどうかを確認する。
pnpm test
pnpm lint
pnpm format:check # pnpm format はコードを自動で修正するため、静的検査が通るかどうかを確認するためには pnpm format:check を使用する。
pnpm build # monorepo のパッケージや /app の Next.js のアプリケーションがビルドされる
- もし静的検査が通らない場合は、エラーの内容を確認して、修正するようにユーザーにフィードバックする。
2. 変更の内容を理解する
- 変更の内容を理解するために、変更されたコードやドキュメントを確認する。
- 変更の内容を理解できたら、レビューのポイントを整理する。
- 少しでも不明な点がある場合は AskUserQuestionTool を用いてユーザーに質問する。
3. レビューのポイントを整理する
- 変更の内容を理解したら、レビューのポイントを整理する。
- レビューのポイントは、変更の内容に応じて異なるが、一般的には以下のようなポイントがある。
- コードの品質: コードが読みやすく、保守しやすいかどうか。
- テストについて:
を参考に、テストが適切に書かれているかどうか。
- React について:
を参考に、React のベストプラクティスに従っているかどうか。
- TypeScript について:
を参考に、TypeScript のベストプラクティスに従っているかどうか。
- パフォーマンス: コードが効率的に動作するかどうか。
- セキュリティ: コードがセキュリティ上の問題を引き起こさないかどうか。
- ドキュメント: コードやドキュメントが適切に記述されているかどうか。
- レビューのポイントを整理したら、次のステップに進む。
4. レビューのポイントに基づいてフィードバックを提供する
- レビューのポイントに基づいて、フィードバックを提供する。
- フィードバックは改善案も含めて具体的に提供する。
Important Notes
- このスキルは日本語によって記述されているが、フィードバックなどはユーザーが使っている言語で行うこと
- このスキルを実行中に、コードの変更を行わないこと。
- レビューが終了したら docs/reviews/ にレビューの内容を保存すること。