GitHub: Code Review, Issue Tracker and Wiki - devuxd/SeeCodeRun GitHub Wiki

Frequently Asked Questions

There are two great free online courses you might find useful. Go to Code School website. "Try Git" for introduction and "Git Real" for learning very useful Git commands.

1. How do I use GitHub to perform a code review?

There are a couple of ways to check if any changes (updates or new code) have been made which requires code review:

  • Pull Request: Check to see if someone in your team has made any Pull Request. Pull Requests are made by your team members to alert that they have pushed changes to the repository.

Once you open the Pull Request, you can see what is about to be merged. You can also start discussion regarding the changes. There are three tabs, Conversation, Commits and Files Changed. In Files Changed tab, you can see the diff of commits and can leave inline comments. For more information on pull request, visit Pull Request page

  • Watch A Project: Subscribe to watch a project on the project page. When the owner updates the project, you will see what happened in your dashboard.

2. How do I find someone to do a code review?

3. What should I look for when I perform a code review?

  • Review Pull Request: You can look for changes made. You can use the File Changes tab in the Pull Request to display the diffs. Also, you can review all the commit comments and which files have changed. You can also get a list of contributors to your branch.

  • In the Pull Request, you can see the diffs but not the full code in its entirety. You will have to go to the branch where the code resides and review it.

4. I just started working on an issue. Should I assign it to myself?

  • Yes, if the issue has not been issued to anyone yet and you are working on the issue, you should assign it to yourself. In this way, your team knows that the particular issue is being addressed by you.

  • In general, it depends on the issue. If you are initiating discussions or posing a question, it makes sense to assign it to yourself. However, if you are delegating a task associated to the issue, you should assign it to the appropriate person. Also, keep in mind that only one assignee can be selected per issue at any given time.

  • GitHub's Issue tracker is similar to bug tracker, but it is more than just bug tracker. It is useful in keeping track of tasks, enhancements and bugs.

5. What happens if I receive feedback that I should make some changes? Should I ask the original reviewer to look at the changes after I'm done?

  • After you are done with your changes, you can create a Pull Request to notify your team or selected members of your team including the original reviewer. Upon receiving your Pull Request, the interested parties will review your changes.

6. I committed a change that fixed an issue. Should I close it?

  • If you name an issue using the keyword (see the list below) such as 'Fixes#1', it will automatically close the issue when you commit it. Otherwise, you should go to the Issue tracker and close it.
  • Close, Closes, Closed
  • Fix, Fixes, Fixed
  • Resolve, Resolves, Resolved