Code Review - sgml/signature GitHub Wiki
Review as an Exercise
| Stretch Type | Physical Exercise | Coding Review Equivalent | Purpose in Review Context |
|---|---|---|---|
| Seated Stretch | Neck Rolls | Context Switching Between PRs | Loosens mental rigidity; refreshes perspective |
| Seated Stretch | Shoulder Rolls | Reframing Error Messages | Releases tension from defensive posture |
| Seated Stretch | Spinal Twists | Reviewing Legacy Code with Fresh Eyes | Improves flexibility in interpretation |
| Seated Stretch | Ankle Circles | Scanning for Off-by-One Errors | Stimulates attention to subtle movement |
| Leg & Hip Mobility | Seated Marches | Reviewing Loop Constructs | Activates rhythm and flow awareness |
| Leg & Hip Mobility | Heel Raises | Spotting Redundant Conditions | Boosts alertness to hidden repetition |
| Leg & Hip Mobility | Thigh Squeezes | Validating Boundary Cases | Builds core logic strength |
| Arm & Wrist Relief | Wrist Circles | Refactoring Variable Names | Enhances dexterity in semantic clarity |
| Arm & Wrist Relief | Finger Extensions | Expanding Comments for Clarity | Stretches communicative reach |
| Head & Neck | Chin Tucks | Reviewing Stack Traces | Grounds the headspace in root cause analysis |
| Head & Neck | Ear-to-Shoulder Stretch | Comparing Two Implementations | Encourages lateral thinking |
| Head & Neck | Upper Trap Stretch | Reviewing Architecture Diagrams | Relieves high-level cognitive strain |
| Martial Arts (Tai Chi) | Cloud Hands (Seated) | Reviewing UI Flow Logic | Promotes graceful transitions and state awareness |
| Martial Arts (Qi Gong) | Heaven & Earth Stretch | Reviewing Top-Down vs Bottom-Up Design | Aligns structural thinking with breath |
| Martial Arts (Judo) | Neck Bridge Prep | Reviewing Exception Handling | Strengthens defensive posture |
| Martial Arts (BJJ) | Seated Shrimp Drill (Mini) | Refactoring Nested Logic | Improves escape routes from complexity |
-
Write down the causes of most of your bugs
-
Create a checklist based on that
-
Self-review your own code
-
Use unit tests of the framework as a baseline for your own tests
-
Use the fundamental code (constructors, loggers, utils) as a baseline for your own code
Review Bias
https://developers.redhat.com/blog/2019/07/08/10-tips-for-reviewing-code-you-dont-like/
https://dev.to/jnschrag/10-lessons-learned-conducting-code-reviews-5di6
Checklists
https://www.youtube.com/watch?v=fatTnX8_ZRk
Code Challenges
https://www.techgig.com/practice/swift
https://docs.aws.amazon.com/wellarchitected/index.html
References
- https://daedtech.com/aggressively-trying-automate-code-review/
- https://slack.engineering/on-empathy-pull-requests-979e4257d158
- https://securitycommunity.tcs.com/infosecsoapbox/articles/2015/11/19/ide-plug-ins-security-testing-way-automate-code-review
- https://smartbear.com/learn/code-review/best-practices-for-peer-code-review/
- http://repository.cmu.edu/cgi/viewcontent.cgi?article=1208&context=sei
- https://resources.sei.cmu.edu/asset_files/TechnicalNote/2009_004_001_15089.pdf
- https://pdfs.semanticscholar.org/dbfd/dad0b98f731ce0c4f3c415be6ab20cdfdd18.pdf
- http://leansoftwareengineering.com/2007/06/05/the-capture-recapture-code-inspection/
- http://users.csc.calpoly.edu/~jdalbey/206/Templates/InspectProcess.html
- https://css-tricks.com/react-code-style-guide/
- https://old.efn.no/naggum-obituary.txt
- https://www.owasp.org/index.php/Application_Threat_Modeling
- https://wiki.php.net/rfc/consistent_type_errors