Reviewing Pull Request Using Visual studio

GitHub web interface or GitHub desktop have very limited features for code review making it very difficult to understand the code in Pull Request. Using IDE like Visual studio to perform the code review can make it much easier to follow the code.

these instructions explain in detail how to set up your IDE and several ways to clone and build a copy of TMPE repo. The instructions bellow focus on reviewing code using Visual studio and assumes you already have set up your Visual studio environment.

Clone source code

Go to TMPE source code : https://github.com/CitiesSkylinesMods/TMPE if you are reviewing code from a fork go to the fork url instead.
click the green "clone or download button"
click "Open in visual studio"
a pop-up may open asking you to install visual studio plugin.
visual studio opens automatically. press Clone to complete the cloning process.

Open pull request

To open a pull request for review follow the steps bellow (pay attention to the red letter markers in screenshot above):

Click on the GitHub tab (B) or click on the GitHub icon in the status bar (A) . Alternatively you can go to menu bar-> View -> other windows-> GitHub.
see Section below if you see error message "could not resolve a repository with the name TMPE"
click the fork icon (C) and then choose krzychu124/cities-Skylines-Traffic-Manager-President-Edition ( or CitiesSkylines_TMPE) from the drop-down (D). If the pull request is from any other fork choose the appropriate fork name from the drop-down.
click on a pull request

Now you should be able to see a list of file changes.

double-click on a file to view diff or right click for more options (C). click on the chat icon (B) to see chat message, but it is better to view the chat in GitHub (A). to check out the code checkout the displayed branch name (D).

Work around Visual studio bug

If you see error message "could not resolve a repository with the name TMPE" then you should work around a bug in VS. this error occurs because we have diverted https://github.com/krzychu124/Cities-Skylines-Traffic-Manager-President-Edition to https://github.com/CitiesSkylinesMods/TMPE and this confuses Visual studio.

Go to team viewer (A or A2) -> Home (B) -> Settings (C)
click on repository settings
under repository section edit origin (A).
In the pop-up window make sure push matches fetch is ticked . copy past this URL ( B) https://github.com/krzychu124/Cities-Skylines-Traffic-Manager-President-Edition then press save (C)
you MUST restart Visual studio for the changes to take place. clicking refresh or closing/opening solution is futile! Close visual studio and open the current repo again.
go to GitHub tab and make sure the error message is gone

Last modified: 09 June 2024