This repository is created for demonstration purposes. Version control with Git and GitHub is taught in the Digital Causality Lab.
Participants of the Digital Causality Lab should use this repo as a template and do the following steps.
- Create your own GitHub repository.
- You can either navigate to your GitHub profile, go to the repositories tab and click on new, or,
- You can use this template by clicking on the Use this template button.
- Open an issues with a task. For example, the title could be "Add some content to the
README.mdfile". - Create a new branch, e.g., named
changes-to-readme. - Make changes to your files on this branch and commit them with a message. Push the changes.
- Open a pull request and review your changes.
- Merge the pull request and pull the
mainbranch again. Verify that your changes have been merged.
After you've completed the previously described steps, please remove the content above. Include the following information in this readme file:
- Please include the title of your case study; an overview of all case studies is available here
- Please list the names and GitHub user names here
- Insert a brief description of the goals and results of your case study (around 250 words, English)
- You can upload and include figures, too
- Briefly summarize the state of your data product as of the end of the course
- Briefly summarize what could be added or improved in the future
We'd recommend you to organize your repo as follows.
- Include figures (
.jpg,.png, ...) in a subdirectory calledfigures/, see this example - Include data files (
.csv,.rda, ...) in a subdirectory calleddata/, see this example - Include your R code (
.Rfiles) in a subdirectory calledR, see this example - In case you use quarto for your data product, include your
.qmdfiles here, see this example
These basic recommendations are intended to give you a bit structure. You can deviate from them as you like but please make sure others should be able to understand what you did. 😄