GitHub pull requests are the primary way you will interact with the Content Team to implement edits to your course. As such, it is very important that you structure your pull requests clearly and include enough information for the Content Team to easily and efficiently process your request.
Please note that all edits must be reviewed by the Content Team. Please allow 3-5 business days for edits to be reviewed and implemented.
Making a pull request
After using the Content Quality Dashboard to identify which exercises need to be updated or changed, open the course in the Teach Editor and create a new branch using the branches button at the bottom left. In the new branch, make your changes. For more information on using Teach to make changes, see this article.
After you've made your changes, wait for the Course Build to finish.
- If the Course Build passes, great! Move to the next step.
- If there are any build warnings are related to your code (e.g., a syntax error), work to diagnose the issue and resolve the warnings.
- If there are any build warnings related to SCTs (e.g., no call of a function was found), please note those in your pull request.
- If there are any other issues with the build, please note this in your pull request.
Go to the GitHub repository of the course and make sure to select the correct branch. Open a pull request, and describe the changes you’ve made using the template below. Then tag @datacamp-contentquality as a reviewer (not as an assignee). The team will review the changes and request additional clarification if needed.
Performing maintenance on a Spreadsheets course:
Spreadsheet courses work a little differently and require different steps to make edits.
After using the Content Quality Dashboard and determining what fixes need to be made, open an issue on GitHub and detail the changes you want to be made, following the format in the template below.
Assign the issue to @datacamp-contentquality for review.
Done! The DataCamp Content Team will contact you if any clarification is needed and will implement the requested changes.
Pull Request Template
All pull requests should include the information contained in this template. Being as descriptive as possible will help the team to review your changes quickly and move the updates to the live course as efficiently as possible.
This pull request addresses [a general overview of the issues addressed].
SCTs will need to be edited for Exercises [exercise numbers where SCTs need to be edited].
Example Pull Request
Here's an example pull request made by a DataCamp instructor.