Maandag 11 september af
1.2 Repository structure and documentation (10%)
The end-to-end workflow, kickstarted with one of the workflow templates available at Tilburg Science Hub, is made publicly available on GitHub. The repository contains a readme.md (in markdown format, so that it renders well on GitHub), which clearly explains the project’s goal, and provides instructions to potential contributors/replicators on how to run the project. The project has a concise and accurate name, enticing the potential user to explore the workflow. An appropriate short name for the repository’s location is chosen (e.g., github.com/yourusername/investigating-airbnb). Additional metadata on GitHub is provided (e.g., a short project description), so that the repository feels and looks professional and complete.
Tip: Structure your README.md
The readme is not a copy of your way of deployment (e.g., your report), but links to it. Therefore, only summarize the main results in your readme (e.g., in bullet point format), or include screenshots (e.g., to your app, to your “best” figure).
More information on how a proper readme should look like can be found at Tilburg Science Hub.