-
Notifications
You must be signed in to change notification settings - Fork 1
Code Review
Jerome Ng edited this page Nov 16, 2021
·
1 revision
This section will serve as the documentation on the process and checklist that we adhered to when doing a code review.
As new features are done up in new branches, before a branch is merged, we would create a pull request.
In the pull request, we will ask for reviewers to look through our changes. Code review will be conducted offline and reviewers would contact the author through Telegram of any changes that is required.
Any violation of the below checklist would be required to be fixed before the pull request is approved by the reviewer and then the merge would occur.
- Does not fail fast enough
- Magical Constants
- Any conditional statements to be handled by polymorphism
- Duplicated codes occur more than twice
- Uses field dependency injection
- Inappropriate handling of Exceptions
- Class has more than 1 responsibility
- Business logic handled in Controller rather than in Service
- Inappropriate HTTP status code returned
- Uses methods from another class more than its own
- Unnecessary conditional check
- No Swagger documentation or Javadoc for methods
- Does not follow best practices
- Return value of API is not used by Front End
- Inconsistent Naming of variables
- Inconsistent Method Signatures
| Issue | File Name | Function Name |
|---|---|---|