Github Pull requests are the primary way you will interact with the Content Quality Team to implement edits to your Course. As such, it is very important that you structure your pull requests clearly and with enough information for the Content Quality Team to easily and efficiently process your request.
After using the Course Dashboard to identify which exercises need to be updated or changed, log in to your course Github repository and open a new branch. For more information on using Github to make changes, see this article.
Make the changes needed to your course, then wait for the Course Build to finish.
- If the Course Build finishes, great! Move to the next step.
- If the Course Build doesn’t pass, you can either try to fix the errors, or contact a member of the Content Quality team in a Github issue.
Go to the Github repository of the course and make sure to select the correct branch (If you go to Github via the Github button in Teach, the correct branch will be selected automatically). Open a pull request, and describe the changes you’ve made. Then use @datacamp-contentquality as a reviewer (NOT as an assignee). The Content Quality team will review the changes and request additional clarification if needed.
Creating Changes in a Spreadsheets Course:
Spreadsheet courses work a little differently, and require different steps to make edits.
After reviewing your course and determining what fixes need to be made, open an issue on Github and detail the changes you want made.
Assign the issue to @datacamp-contentquality for review.
Done! The DataCamp Content Quality team will contact you if any clarification is needed, and will implement the requested changes.
Tips and Best Practices for Writing a Github Pull Request
- Always, always, ALWAYS create a new branch for each round of edits! Do not work off an old branch that may have edits that have already been implemented! Additionally, other edits may have been made to the course since that branch was active, which may cause conflicts that are difficult and time consuming to resolve. (You can request as many edits as needed per branch, but once it has been reviewed by the Content Quality team, consider that branch “closed”).
- List which specific exercises you have made changes to. (See template below)
- If necessary, include a screenshot of the issue.
- Make sure to tell the Content Quality Analysts if you have changed code. This is very important, as code changes will require a corresponding change to the Submission Correctness Tests (SCTs).
Being as descriptive as possible will help the Content Quality Team to review your changes quickly and move the updates to the live course as efficiently as possible.
Example Pull Request Template:
You do not need to copy the format below exactly, but instead, use this template as a guide for helpful information to provide in your pull request.
- Brief description of changes made affecting multiple chapters or overall course (such as Chapter descriptions or titles)
- Exercise XX: Brief description of initial problem (why changes needed to be made) what changes were made, including if code was changed (The most important aspect is listing which exercises were changed and how)
(Repeat as needed for remaining Chapters)
SCTs Will Need to be Updated On:
- List exercises where code has been changed and SCTs will need to be corrected
(Include these sections if necessary)
- Brief description of issue, including Chapter, video number, and slide number within video. (including approximate time of issue within video and screenshot of issue or change may also be helpful)
- If the Course Dashboard exercise level metrics (%SCT Helpful) indicate that many learners are not finding the SCTs helpful, please let the Content Quality team know to review