Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/klieret/collaborative-programming-github

Hands-on lecture material to explore collaborative programming with git and github
https://github.com/klieret/collaborative-programming-github

collaboration git github hands-on lecture lecture-slides slides training tutorial

Last synced: about 2 months ago
JSON representation

Hands-on lecture material to explore collaborative programming with git and github

Awesome Lists containing this project

README

        

Collaborative Programming with GitHub

[![PR welcome](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg)](https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project)
[![gh actions](https://github.com/klieret/collaborative-programming-github/actions/workflows/deploy.yml/badge.svg)](https://github.com/klieret/collaborative-programming-github/actions)

> **Note**
> 👉 [**Click here for rendered slides!**](https://klieret.github.io/collaborative-programming-github/) 👈

> **Warning**
> This is **not** the playground repository.
> Pull requests that improve the lecture are much appreciated though!

Slides to introduce collaborative programming with git.
This lecture aims to be 90% hands-on and at least 90% collaborative.

- Part 1: Learn to fork, branch, create PRs, resolve merge conflicts, all from the GitHub web interface
- Part 2: Let's contribute from the command line
- Part 3: Learning to love git

> **Note**
> You can use these slides for your teaching, too (see license)! Contributions are very welcome as well.

> **Note**
> PDF versions are available in the releases.

screenshot of slides

Taught as

- [*Collaborative Software Development with Git(Hub)* at the CoDaS-HEP 2023 school](https://indico.cern.ch/event/1287965/)
- [*Let's Collaborate! Software Development Using the GitHub Web Interface* at Princeton University](https://gradschool.princeton.edu/events/2023/lets-collaborate-software-development-using-github-web-interface)
- [*Collaborative programming* at the CoDaS-HEP 2022 school](https://indico.cern.ch/event/1151367/).

## 🌐 Other resources

Less related training material built with the same markdown-based framework:

* [Everything You Didn't Know You Needed](https://github.com/klieret/everything-you-didnt-now-you-needed)

## 🧰 Local development

The slides are built with [Slidev](https://github.com/slidevjs/slidev).

To start the slide show locally:

- `npm install`
- `npm run dev`
- visit http://localhost:3030

Edit the [slides.md](./slides.md) to see the changes.

Learn more about Slidev: [official documentation](https://sli.dev/).

When contributing, please also set up the pre-commit hooks with

```bash
pre-commit install
```

## Lecture content

Part I + III took 1h30 to teach (for the `codas-hep 22` release).