HowToCodeReview
Every MarkUs developer has to perform a Code Review before it can be merged (even for the smallest commit). This is a short guide as to how to use github Code Review system.
Once you have created a branch, worked on your code and committed your changes to your local git repository you are ready to create a review request.
1) Go to the github Web interface, find your fork, switch to the branch you have been working on and create a pull request (there should be a button for it).
Creating a Pull Request for a Code Review
-
Enter an appropriate "Title"
-
In the "Write" field, be sure to include the following
- Issue number in the following format #XXX
- Summary of the issue and your solution to the issue
- What testing was performed
In general, after a review-request has been uploaded, there are 3 steps code, topic of a review-request, has to go through before it gets checked in into the MarkUs source code repository: 1. comment review-request 2. revise review-request (if need be) and 3. check in changed source code (_provided_ the review-request got a green light). Step one and two need be repeated as appropriate and until the review-request gets an ok (or gets dropped without being committed at all).
But how to comment review-requests? The following steps outline how to do these things:
- Go to <https://github.com/MarkUsProject/Markus/pulls/> and log in with your credentials
- Once you have the desired review-request open, click on "Files Changed"
- Comment code by clicking the blue + on the on appropriate line numbers on the left. By pressing "Comment on this line", your review comments will be publish immediately.
- If you think code is ready to be committed, give a message like "Good to Commit" or "Ready for Merge". A core MarkUs developer will merge the pull request.