raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-03-27 06:05:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated How to do Code Reviews (markdown)

Luis Ramos
2018-08-19 11:04:14 +01:00
parent d75c05f8c9
commit dfc6d2fb4f
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
How-to-do-Code-Reviews.md

@@ -6,4 +6,5 @@ Things you should verify as you code review a PR:
* Make sure the changes are tested at appropriate level (see [rspec tips](Testing-and-Rspec-Tips) and [karma tips](Karma) for help)
* Make sure tech [best practices](Code,-the-way-we-do-things) are being followed
* Focus on the implications, design, readability and complexity of the change rather than only its syntax. The latter is what machines are meant to do and that's why we use [Rubocop](http://batsov.com/rubocop/).
* Make sure [code conventions](https://github.com/openfoodfoundation/openfoodnetwork/wiki/Code-Conventions) are followed (things [Rubocop](http://batsov.com/rubocop/) doesn't check)
* Make sure the boy scout rule is applied: when changing code, it's important to respect the existing structure, but it's even better when we refactor on the way and improve the code we are changing.