As you should already know by this time, our course editor, Teach, is built on top of GitHub, so it should not be surprising that we use GitHub for course review as well. While it is out of the scope of this article to teach you how to use GitHub, it will give you an overview of the ways courses can be reviewed using GitHub and point you to articles written by the people at GitHub. If you are already familiar with GitHub, then these concepts won't be new, but if you are new to GitHub, we highly suggest you read click through to the GitHub articles to gain an understanding of pull requests, merge conflicts, and proposed changes.
If you've never heard of a pull request (PR) before, you should start here: About pull requests.
Course review mechanisms
- Creating a pull request. When your content is ready for review, you will need to do two things: check off the specified tasks in your Asana project and create a PR.
- Requesting a pull request review. You will need to request your CL or CD as a reviewer on your PR.
- Resolving a merge conflict on GitHub. Your CL or CD will resolve any merge conflicts, as this may be related to underlying formatting changes.
- Reviewing proposed changes in a pull request. Your CL or CD can use the review feature to review the changes you've made and either "approve" or "request changes."
- Viewing a pull request review. If your CL or CD uses the pull request review feature and requests changes, you will need to review the changes in GitHub, which appear as conversations. Make changes to your course in Teach, not GitHub. Once changes have been made, you should resolve the related conversation (learn how here: Resolving conversations). If you do not agree with the proposed change, then respond to the comment directly. Once you've finished implementing changes, @mention your CL or CD to notify them.
- About branches. A CL or CD may create a new branch (off of your branch), make some proposed changes to your course, and then issue you a pull request.
- Creating an issue. Your CL or CD may give you feedback on your course in a GitHub issue.
- Your CL or CD will provide at most, two rounds of feedback on your content.