amsterdam.github.io icon indicating copy to clipboard operation
amsterdam.github.io copied to clipboard

Guide Request: How to Code Reviews / Pull Requests

Open bvhme opened this issue 8 years ago • 1 comments

As needed for #8

As per current contrib-guide:

  • Style — identify discrepancies from this guide
  • Potential Bugs — try to think about what might break
  • Error Handling — if something external can cause an exception, how will the user experience it?
  • Efficiency — will things scale and still be responsive?
  • Readability — can you understand what's going on?
  • Requirements — does the commit fulfill the requirements of the ticket
  • Does the code do what is should do -- run the code and see if it does not do weird things like downloading the internet.
  • Check that code endpoints and parameters are sufficiently tested -- there should be minumum amount of health checks
  • Debug mode / health checks -- Common security mistakes should be checked.
  • Decide for yourself if you could maintain and bugfix the code you see

bvhme avatar Oct 18 '17 11:10 bvhme

I believe this issue still applies due to the new PR #21

MauriceHendriks avatar Oct 23 '17 09:10 MauriceHendriks