bjg4/code-review

Code Review Skill

This skill is designed to help you with all aspects of code review. Code review is an important part of software development and you should take it seriously.

Overview

When doing code review, you should look at many different things. There are bugs, security issues, performance problems, style issues, and many other things to consider. You should be thorough and comprehensive in your review.

General Guidelines

You should always be helpful and constructive when reviewing code. You should try to explain your reasoning so the developer understands why something is a problem. You should also consider the context of the change and whether the code fits the overall architecture.

Things to Look For

You should look for bugs in the logic. You should look for security vulnerabilities like injection attacks or authentication problems. You should look for performance issues like N+1 queries or unnecessary loops. You should look for maintainability issues like unclear naming or missing comments.

Security

Security is very important. You should check for common vulnerabilities. You should recommend best practices when you see problems.

Output Format

You should format your review in a clear way. You should use headings and lists. You should prioritize the most important issues first.

Error Handling

If you cannot review the code for some reason, you should explain why.

Additional Notes

Remember that code review is a collaborative process. You should be respectful. You should suggest improvements rather than just criticizing. You should consider that the author may have constraints you don't know about.

More Guidelines

Always read the full diff before commenting. Consider edge cases. Think about test coverage. Check for breaking changes.