How to participate?
If you want to participate in the next version of this training, please complete this expression of interest form.
All data will be handled confidentially and may only be published in aggregated and anonymised form in reports on the scope of Epiverse-TRACE.
What will you learn?
Explain why you need to know about Version Control if you work on an Open Science project.
Describe the most common verb commands to track changes using Git as a Version Control software within Rstudio.
Create a personal online profile to share my tracked changes on the web using GitHub.
Identify good practices to describe my tracked changes using Git and collaborate with others using GitHub.
Who is this training for?
This training is pitched to beginners with basic knowledge of Git who wish to learn more. Three examples of the type of learner who would benefit from this training are included below. The course will be relevant to those from various backgrounds (research degree students, project managers, etc.)
We thought about Lucia, Patricia, and Pepe as learner personas in designing the contents of this training:
Lucia is a Field epidemiologist. She uses R to clean data and create plots for outbreak response. She wants to communicate her doubts and ideas with package maintainers.
Patricia is a PhD student in a team with data analysts. She uses R to analyse infectious disease data. She wants to make her research code reusable and open to public.
Pepe is a Project Manager interested in community building. He wants to learn how to provide feedback on contributing good practices to Open Science projects.
What is not included in this training?
Topics that are out of the scope of this training include:
How to solve conflicts when merging branches.
How to revert commits as a safe method to undo changes.
How to review pull requests in GitHub.
How to use GitHub Actions for continuous integration of software.
Duration
The duration of this training is of 3.5 hours with breaks of approximately 5 minutes each 60 minutes.
Program
| Time | Activity |
|---|---|
| 2:00 - 2:05 | Introduction |
| 15min | What is version control and why should I use it for Open Science projects? |
| 5min | The general workflow |
| 10min | How do I set up to start using Git? |
| 10min | Where does Git store information? |
| 30min | How do I record changes in Git? |
| 5min | Break away from the screen |
| 20min | How do I record notes about my changes and why? |
| 30min | How can I identify old versions of files? How do I review my changes? |
| 10min | How can I tell Git to ignore files I don’t want to track? |
| 5min | Break away from the screen |
| 20min | How do I share my changes with others on the web? |
| 30min | How can I use version control to collaborate with others? |
| 15min | What do I do when my changes conflict with someone else’s? |
| 5:30 - 5:35 | Closing |
Materials you will need
We will use Git within the Rstudio graphical interface and GitHub. For this you will need to use these instructions:
- Install R and Rstudio https://posit.co/download/rstudio-desktop/
- Install Git https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
- Create a GitHub account https://github.com/signup
Materials we used
- Slides that we used in the training with notes expanding the content for instructors
- Template for our document with shared notes
- Template for our pre-training form
- Template for our feedback form at the end of the training
- Video of the last version of the training
Any questions?
If you need any assistance installing the software or have any other questions about the training, please send an email to andree.valle-campos@lshtm.ac.uk
Attributions
- This page format is inspired by Metadocencia.
- The image of this feed is from Unsplash, provided by Priscilla Du Preez, free to use under the Unsplash License.
Reuse
Citation
@online{valle-campos2022,
author = {Valle-Campos, Andree},
title = {Introductory Training on {Git} and {GitHub} Basics Using
{Rstudio}},
pages = {undefined},
date = {2022-12-05},
url = {https://epiverse-trace.github.io//learn/git-training-01},
langid = {en}
}