Skip to content

Latest commit

 

History

History
32 lines (16 loc) · 2.83 KB

review-in-written.md

File metadata and controls

32 lines (16 loc) · 2.83 KB

GitHub PR code review process

  1. Open your local (cloned) version of the module's HYF repository, say JavaScript in VSCode (make sure that you run npm install after cloning).

  2. Click on the GitHub Pull Request icon in the VSCode task bar and expand the All option. As shown in the picture below, you will see a list of the most recent Pull Requests for this repository.

  3. Right-click on the pull request you want to review and select the Checkout Pull Request menu option. This will create a local branch in the local repository, e.g. pr/veliataseven/273 as shown in the VSCode status bar.

  4. While the VSCode Github Pull Request extension allows local commenting on the pull request, it's recommended to do it online, directly in GitHub. To open the pull request in GitHub right-click again on the pull request in VSCode and select Open Pull Request in GitHub.

  5. Now switch to the regular code window in VSCode by clicking on the Explorer icon in the VSCode task bar and start the actual review.

    If the trainee installed additional dependencies in package.json you will need to run npm install again. For the JavaScript modules this should not be necessary.

  6. If there are any unit tests as part of the repository, run them and review the results.

  7. Run the code (in Node for a CLI app or in the browser with the console open for an HTML app) to ensure that it at least runs without run-time errors.

  8. Go through the code on GitHub and insert comments in the pull request. When making the first comment select Start a Review, instead of making single comments. Note that for each single comment GitHub sends out an email notification to all repository watchers. It will only send out a single notification for a complete review.

  9. Point out fragments of code that do not work, or do not meet the requirements of the assignment. Trainee need to follow-up on these comments before their pull request can be approved.

  10. Make recommendations on how things can be done better, more elegant, more efficient, etc. However don't consider these showstoppers for approving the pull request.

    Before suggesting a non-trivial coding alternative to trainees, I try it out by modifying the code in the current branch and running it. When I'm satisfied I copy the relevant code snippet in a comment on GitHub and discard the local changes using the VSCode Discard Changes option.

  11. When done select Review changes in the pull request, add an overall assessment in the comment box and either Approve or Request changes.

  12. Finally, I add the label approved when the assignment meets the requirementr or needs work if I requested changes.

  13. Maybe the most important step: after the trainee implemented your feedback, check if their improvements are sufficient and if so, remove needs work and add the labelapproved