Code Review & Merge Request Standards

Code Review Checklist

• Ensure code follows project standards and best practices.
• Check for clear naming, formatting, and documentation.
• Verify tests for new features and bug fixes.
• Review security, performance, and error handling.
• Confirm no secrets or sensitive data are committed.
• Validate migration and deployment steps if relevant.

Merge Requests

• Use descriptive titles and summaries for merge requests.
• Reference related issues or tickets.
• List changes, motivation, and any follow-up steps.
• Request review from relevant team members.
• Address review comments and update code as needed.

Example Merge Request Description:

feat: add user registration form

- Implemented registration form and validation
- Added tests for form and view
- Updated documentation and deployment steps

Best Practices

• Review code in small, focused changesets.
• Use automated checks (linting, tests) in CI/CD.
• Document review process for new team members.
• Encourage constructive feedback and collaboration.