VibrentHealth

Code Review

Review

Take a look at the code. You can use the github interface to review it line by line. You might want to check that:

Code makes sense. When you read it you understand what that piece of code is doing.

Code is well commented. If some function is not obvious, it has a comment that makes sense and explains what’s doing or why it has beeen added.

No debug code was committed unintentionally.

No Config files that should be ignored were added.

And finally, if you feel that some functionality could be achieved in another (ie: better) way, add a comment to that line and discuss it with the person who committed the PR.

Code review is important for: Finding errors AND finding better ways to do things. Two (three, four, etc) brains / eyes are always better than one :)

Test

After the code review, you can test the changes. For that, checkout the PR branch

Example:

$ git checkout mariana/MTW-999_check_these_lovely_changes

OR

$ git checkout -b <PR-branch> <username>/<PR-branch>

And manual test the changes taking notes if you find errors or strange behaviours.

Merge

After that, if you are ready to merge the PR, issue:

git checkout dev && git merge --no-ff <PR-branch>

So we incorporate all changes in Dev (or whatever branch you are using as base) into the PR branch.