GitHub for course review
1. GitHub for course review
Now let's talk about how to use GitHub for content review.2. Back to the repo
Once you're ready for your content to be reviewed, you'll want to leave the course editor and head to your GitHub repo. While it is out of the scope of this lesson to teach you how to use GitHub, it is imperative that you understand one important feature: the pull request. If you've never heard of a pull request, or PR, before, you should finish this lesson and then head to GitHub guides at help dot GitHub dot com for more information.3. Pull requests (PR)
In your repo, you'll need to create a PR to indicate your content is ready for review. This pull request is just as it sounds: you request that the work you've done in the head branch is "pulled" into the base branch.4. Pull requests (PR)
You need a base branch you want your changes "pulled into." This is typically the master branch.5. Pull requests (PR)
The head branch is the branch you're working on, Chapter 4 in the above example.6. Pull requests (PR)
Once you've ensured your base and head branches are correct, click "Create pull request.7. Merge conflicts
You may notice some conflicts arise in your PR that need to be resolved. If you are already familiar with merge conflicts, feel free to resolve these yourself. Otherwise, let your CM or CD resolve your merge conflicts.8. Diffs
Once you've created the PR, you can view the differences, or diffs, by clicking on the "files changed" tab in your pull request. Files listed in this tab are slightly different between the head branch and the base branch. Your proposed deletions to existing content are highlighted in red on the left, and proposed additions are highlighted in green on the right.9. Pull request reviews
To request a review on your PR, head to the conversation tab.10. Pull request reviews
On the right side of the page, at the top, it says "Reviewers." Just click on this, type in your CM or CDs GitHub handle and click on the result.11. Pull request reviews
If there is enough activity on a repo by a certain user, they will be suggested as a reviewer, allowing you to simply click "Request."12. Comments, Approvals, and Requesting Changes
Sometimes, when reviewing your content, your DataCamp contact may want to propose some changes to you.13. Review comments
When reviewing a pull request, there is the option to start the review within the PR itself. Feedback will appear as inline comments that need to be resolved.14. Resolve comments
Once you've implemented the proposed changes from the comment in the course editor, resolve the conversation.15. Using issues for feedback
Sometimes inline comments in PRs can be challenging to read; therefore, feedback may be provided in a GitHub issue instead. Typically in an issue, you will receive some general feedback and targeted feedback, which often includes tasks you should check off once they've been addressed.16. Merging
Once all feedback has been incorporated, and all your merge conflicts are resolved, your branch is ready to merge into master. Remember that the master branch is protected and only DataCamp has admin rights on your course. Your CM or CD will merge in your changes for you. Once everything is merged, you'll be able to move onto the next step in Development.17. Let's practice!
To learn more about GitHub and pull requests, visit GitHub's help pages. But for now, let's test your PR knowledge with some exercises.Create Your Free Account
or
By continuing, you accept our Terms of Use, our Privacy Policy and that your data is stored in the USA.