Documentation for the for the DSCoV (Data Science, Computing, and Visualization) Workshop: Collaborative Coding using Git, GitHub and Pull Requests

The repository is available here:

https://github.com/dscov-tutorials/how-to-pr

Overview

<aside> 🎯 Aim for the Workshop

Collectively format a copy of the Wikipedia page about Git using “Markdown,” one of the text formats which GitHub uses for README files, comments on code, etc.

</aside>

⇨ Start Here We’ll start from an incorrectly formatted version of the Wikipedia page about Git.
Branch
- Issue: You’ll choose an issue.
- Clone: You’ll clone the repository.
- Branch: You’ll make a “branch” which can be shared, where you can make changes.
- Commit: You’ll make a series of “commits” where you actually fix the issue, bit-by-bit.
- Push: You’ll “push” your branch to GitHub.
Merge
- Create: You’ll make a “pull request” (PR) which says "please incorporate the changes in your branch into the main branch.
- Review: Reviewers (your peers) will have the chance to look at the PR and suggest changes and improvements, or to say “this is great, let’s merge it!”
- Merge: Someone will merge the approved PR (or close it otherwise).
- Clean up: After merging, the now-defunct branch can be deleted.
- Update: Everyone will update their now-outdated-PRs to incorporate the new merged changes, before they too are merged.
- Merge Conflicts: If people work on the same part of the document, then the authors will resolve the conflicting changes.