After signing a contract to create your project, instructors are set up with a private GitHub repo in the DataCamp GitHub organization. The structure of this repo must contain specific files with specific names, otherwise, the project will not build successfully, and it won’t display on datacamp.com.
A master branch and a develop branch exist in the repo. The
develop branch is where instructors develop the project until it is ready for release. Instructors are not to make changes to the master branch.
The relevant files/folders in the project repo are:
project.ipynb: The file that will hold the final project.
audition.ipynb: The audition document, if one was submitted, which contains the first draft of the
@solutioncode for the first three tasks of the project.
project.yml: The metadata for the project. The project title, project description, etc.
img/: The folder where images go.
datasets/: The folder where datasets go.
README.md: This contains links to the project dashboard, where you can check to see what the rendered project would look like on datacamp.com. This dashboard also has guideline checks (e.g., warnings saying cell-specific character counts are exceeded, etc.) that will appear after content is pushed to GitHub. This also contains a link to your Asana project.
requirements.R: The file where packages are installed. If this file isn't complete, you will run into errors when running code in your project on datacamp.com. These errors are also reported in the project dashboard.