/lyrics-Oct3

Primary LanguageRich Text Format

Intro to Git and GitHub training - Contributor

This repository was created for a training session of DIME Analytics Intro to Git and GitHub Training - Contributor. You can read more about DIME Analytics Git and GitHub trainings here.

This is one of two beginner trainings. This one is for Contributors: people that will make code contributions and provide feedback using Git/GitHub. You can read more about Contributors and other roles in DIME Analytics Suggested GitHub Project Roles.

About this training

This training targets both absolute beginners and people with some Git/GitHub experience who want to learn best practices for contributing to a project using Git/GitHub. This training will not teach you everything about Git and GitHub, but after this training you will know how to contribute to a repository.

The training is designed for someone joining a team that is already using Git/GitHub, or that is about to start, and has a team member that is experience with GitHub workflows. This training will not teach you how to create a repository, how to set up work flows and best practices for a team using Git/GitHub, or how to solve conflicts etc. in a repository. However, you will be able to figure out most of them yourself after this training, if you are willing to use Google a little bit.

We hope you like Git as much as we do!

Content in this repository

While Git/GitHub is a tool primarily for code development, there will be no code during this training. In our experience, code distracts participants (as they want to find out what it is trying to do), and the training applies regardless of intended programming language. So this training is 100% programming language agnostic and has no requirement of coding skills.

Instead we will create an archive of great song lyrics. We will add lyrics to this repository in .txt files. We use that file format as it will behave the same way as any code file, but without distracting us.

Doing this training on your own

This training was developed to be an interactive training taught by an instructor, but we are happy to share all material. You can find all the materials used in this training on the DIME Analytics GitHub training repo. This repo also include the material for all our other GitHub trainings and resources.

Slides. Go to the latex-slides folder to find the LaTeX code used to generate the slides used in this training. Read more about LaTeX in our LaTeX guidelines.

Training repo. There are two ways you can recreate an identical copy of how this repo looks at the beginning of this training. If you are following a recording of this training and want to follow along, then this is what you need to do.

  1. The easiest way is to import a copy of the repo to your account. If you want a clean copy of the repo, make sure to use this URL: https://github.com/dime-wb-trainings/lyrics-clean.

  2. If you want to modify how these slides are created, then you can find the python code used to set up this repos in the jupyter-repo-setup folder. You can modify that script to create a copy of the repo however you want.

Contact

If you have any questions about this training, please email us at dimeanalytics@worldbank.org