|
| 1 | +--- |
| 2 | +description: |
| 3 | +globs: |
| 4 | +alwaysApply: false |
| 5 | +--- |
| 6 | +# Code Review Guidelines |
| 7 | + |
| 8 | +When asked to perform a code review for a module, class or function. |
| 9 | + |
| 10 | +## Code Style |
| 11 | + |
| 12 | +Ensure the code adheres to the development standards outlined in [standards.mdc](mdc:.cursor/rules/standards.mdc): |
| 13 | + |
| 14 | + |
| 15 | +## Tests |
| 16 | + |
| 17 | +All code changes must include appropriate tests as defined in [testing.mdc](mdc:.cursor/rules/testing.mdc): |
| 18 | + |
| 19 | + |
| 20 | +## Documentation |
| 21 | + |
| 22 | +Verify documentation standards from [standards.mdc](mdc:.cursor/rules/standards.mdc) and [documentation.mdc](mdc:.cursor/rules/documentation.mdc): |
| 23 | + |
| 24 | + |
| 25 | +## API Semantics |
| 26 | + |
| 27 | +- **Interface Design** |
| 28 | + - Clear and consistent API contracts |
| 29 | + - Proper input validation and output formatting |
| 30 | + - Backward compatibility considerations |
| 31 | + - Appropriate HTTP status codes and responses |
| 32 | + |
| 33 | +- **Data Flow** |
| 34 | + - Proper handling of inputs, transformations, and outputs |
| 35 | + - Validation of data at boundaries |
| 36 | + - Consistent data structures and formats |
| 37 | + |
| 38 | +## Contributing Guide |
| 39 | +Please ensure the change adheres to the pull request guidelines in [CONTRIBUTING.md](mdc:CONTRIBUTING.md): |
| 40 | + |
| 41 | +## Review Checklist |
| 42 | + |
| 43 | +- Code follows [standards.mdc](mdc:.cursor/rules/standards.mdc) style guidelines |
| 44 | +- Tests follow [testing.mdc](mdc:.cursor/rules/testing.mdc) requirements |
| 45 | +- Logging uses [logging.mdc](mdc:.cursor/rules/logging.mdc) standards |
| 46 | +- Documentation is updated per [documentation.mdc](mdc:.cursor/rules/documentation.mdc) |
| 47 | +- PR follows [CONTRIBUTING.md](mdc:CONTRIBUTING.md) guidelines |
| 48 | +- Security considerations addressed |
| 49 | +- Performance implications considered |
| 50 | +- Resource management properly handled |
| 51 | +- Error handling is comprehensive |
| 52 | +- API contracts are clear and consistent |
| 53 | + |
| 54 | +Refer to the [CONTRIBUTING.md](mdc:CONTRIBUTING.md) for guidelines for contributors |
0 commit comments