Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 

README.md

Code Review Checklist

A hardly exhaustive collection of considerations when peer-reviewing software.


Clean, merge-ready pull requests:

Functionality
  • implement relevant specification(s)
  • anticipate and address failure modes
  • avoid (or adequately justifies) obvious performance issues
  • provide appropriate user feedback
  • expose logs, errors, and other runtime debugging details as needed
Testing
  • secure behaviors described in relevant specification(s)
  • test public interfaces
  • cover anticipated failure modes
  • benchmark recognized performance issues
  • run green
Legibility
  • embrace style and patterns established by the project, team, and community
  • consume existing libraries, methods, and types
  • use suggestive names for functions, variables, and classes
  • document public interfaces as appropriate
  • remove (or adequately support) TODOs, legacy code, and hacks
Security
  • bound and sanitize inputs
  • sanitize outputs, including analytics and logs
  • recognize and address common vulnerabilities (SQL injection, XSS, buffer overruns, etc)
  • isolate platform-/environment-specific functionality
VCS Hygiene
License

MIT licensed - fork, contribute, and enjoy!

About

A hardly exhaustive collection of boxes to check

Resources

License

Releases

No releases published

Packages

No packages published