AIを活用したコードレビューワークフロー

毎回のマージ前にAIを使ってバグを発見し、標準を適用し、コードを文書化します。

4 steps
codingdeveloper-toolsproductivity
1

コードを貼り付けてバグレビューを依頼する

PRを開く前に、変更された関数をAIツールに貼り付け、バグ、エッジケース、ヌルポインタリスクを見つけてもらいます。

Example prompt
Review this code for bugs, edge cases, and potential runtime errors. List each issue with: location (function/line), severity (critical/medium/low), what can go wrong, and a suggested fix. Code:

[PASTE CODE HERE]
2

コードスタイルと命名規則を確認する

AIにスタイル違反、一貫性のない命名、チームの規約に従っていないものにフラグを立ててもらいます。

Example prompt
Review this code for style and consistency issues. Check: naming conventions (variables, functions, classes), function length, comment quality, magic numbers, and DRY violations. Team conventions: [DESCRIBE YOUR CONVENTIONS]. Code:

[PASTE CODE HERE]
3

インラインドキュメントを生成する

AIを使って各パブリック関数のJSDocまたはdocstringコメントを作成します。コミット前に正確性を確認してください。

Example prompt
Write JSDoc comments for each function in the code below. Include: one-line summary, @param with types and descriptions, @returns with type and description, @throws if applicable, and one usage example per function. Code:

[PASTE CODE HERE]
4

PRの説明を書く

差分を貼り付け、AIにPRの説明を書いてもらいます:何が変わったか、なぜ、テスト方法。10分節約できます。

Example prompt
Write a pull request description for the following code changes. Include: Summary (2-3 sentences on what changed and why), Changes Made (bulleted list of key changes), How to Test (step-by-step testing instructions), Screenshots (placeholder if UI changed), and any Breaking Changes. Diff:

[PASTE DIFF HERE]
Ready to try LockedIn AI?
Follow this playbook with the actual tool
View Tool