hof 20.5.3 → 20.5.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/codeReviewChecklist.md +22 -0
- package/package.json +1 -1
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# HOF code review checklist v1.0
|
|
2
|
+
|
|
3
|
+
This is a general guide on what you should check for when reviewing another team member's code.
|
|
4
|
+
|
|
5
|
+
## Fundamental checks
|
|
6
|
+
- [ ] Check for code format
|
|
7
|
+
- [ ] Check for duplicate code
|
|
8
|
+
- [ ] Check for if there are existing components in the framework already
|
|
9
|
+
- [ ] Check for copy and paste
|
|
10
|
+
- [ ] Check code readability (if the class, function and variable names are making sense, avoid using acronyms, check for simplicity, avoid complexity)
|
|
11
|
+
- [ ] Check if user inputs are sanitized
|
|
12
|
+
- [ ] Check if errors are handled
|
|
13
|
+
- [ ] Check if null / undefined values are checked before actions are performed on a variable (May not always be necessary)
|
|
14
|
+
- [ ] Check for performance (are there logic in loops that doesn't have to be executed each time? Could some tasks be added to a queue and performed later? etc)
|
|
15
|
+
|
|
16
|
+
## Advanced (optional if the ticket is low / medium impact) checks
|
|
17
|
+
- [ ] Check if the code is following SOLID principle, code maintainability
|
|
18
|
+
- [ ] Check if none functional requirements are needed (for example, should an audit log be stored for an action performed)
|
|
19
|
+
- [ ] Check the performance and efficiency of the tests
|
|
20
|
+
- [ ] Check to avoid the use of operations that only work in javascript (e.g. using && to return the object on the right if the statement on the left is true)
|
|
21
|
+
|
|
22
|
+
|