Code Review Checklist

What it does

This skill provides a comprehensive code review checklist to ensure higher quality and more maintainable code. It covers aspects like error handling, security vulnerabilities, performance considerations, and adherence to coding standards. The checklist is designed to be adaptable for various programming languages and project types.

When to use it

• Before submitting pull requests: Use the checklist to systematically review your own work before asking others to do so.
• During code reviews: Leverage the checklist as a guide during peer reviews to ensure all critical aspects are considered.
• For onboarding new developers: Provide the checklist as a resource for new team members to understand coding standards and best practices.
• When refactoring existing code: Use it to guarantee that changes don't introduce regressions or compromise quality.

Key capabilities

• Provides a structured code review process.
• Covers error handling, security, performance, and style guidelines.
• Adaptable for various programming languages.
• Helps ensure consistent code quality.

Example prompts

• "Generate a code review checklist for this Python function."
• "Review this JavaScript code snippet using your checklist and highlight potential issues."
• “Give me the error handling section of your code review checklist.”

Tips & gotchas

The effectiveness of this skill relies on providing clear and concise code snippets or descriptions. While adaptable, it's best suited for backend development contexts as indicated by its category.