Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added DOCS.md
Empty file.
95 changes: 61 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,64 @@ nav_exclude: true
published: false
---

# GitHub for Collaborative Data Science & Engineering in Industry & Academia

## Steps that we need to deal with:

### Not in the tutorial

0. Everyone should sign up for a GitHub account (before the workshop)
1. 20 or so minutes of basics (Decide about what and who) "We don't make mistakes, just happy little accidents"

### In the tutorial (included)

2. Split everyone in groups (tables)
3. Create a repository (one per table). It should have a README, LICENSE, description and gitignore.
4. Add collaborators
5. Everyone write their names to the README and commit to master
6. Everyone create an issue based on a question (from a provided list)
7. Pick an issue to resolve (Assign it to yourself and leave a nice, kind comment telling others you're gonna own it)
8. Everyone create a branch to address their assigned issue
9. Create a folder and file (come back to give them path instructions)
10. Commit the new file
11.1 Do a compare [and open a pull request and link to issue in description]

### In the tutorial (to be included)

11.2 [Do a compare] and open a pull request and link to issue in description
11.b Checkpoint/timecheck (How many tables have a pull request)
12. Assign a reviewer (The person who created the issue)
13. The reviewer changes branches and learns "find/navigate"
14. view diff in the pull request
15. Make a general comment on the pull request
16. Make a comment on a line in the file on the pull request ("Add a single comment")
17. Click "Resolve conversation"
18. Merge with master
19. Delete the merged branch
# GitHub for Better Collaboration in Data Science & Engineering

Hello! If you're at our workshop right now, please go [here](#Workshop).

If you missed out on our workshop, but want to see what we did, view our slides [here](/slides) and the workshop [here](#Workshop).

If you *were* at our workshop and/or are looking for some recap reading on Git & Github, go [here](DOCS.md).

Spotted a typo, a broken link, a garbled sentence, etc? We hear you're awesome at [logging an issue](https://github.com/feiphoon/github-workshop/issues) ;)

## Credits

Made by @alesssia, @estramcar & @feiphoon.
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note here - these are not automatically turned to links by Github. I didn't know if you wanted them to be, as sometimes profiles are a ship graveyard of stale public repos :D


## Workshop

### Setup

0. (Before the event) Sign up for your own Github account here: (https://github.com/join) & charge your laptop.
1. A welcome & brief introduction to basic Git concepts. (20min)
2. Everyone splits into groups of 2-4, one group per table. Say hello to your new teammates! (5min)

### Exercises

#### Creating a repository (one person)
3. Each group should pick one teammate to create a repository in Github. It should have a README, LICENSE, description and `.gitignore`.
4. The repository owner should add their teammates as collaborators on the repository.

#### Making commits (everyone)
5. Write your name in your group's repository README and commit it directly to `master`.

#### Creating issues (everone)
6. Create an issue based on a question (from a provided list).

#### Responding to issues (everyone)
7. Pick an issue to resolve, by assign it to yourself and leave a nice comment telling others you're gonna own it.
8. Create a branch to address your assigned issue.
9. Create a folder and file (with path instructions)
10. Commit your new file to your branch.

#### Asking for a review (everyone)
11. Use compare on your own branch to look at your own changes, and open a pull request. Link to the issue in the pull request description.
12. Catch-up point/timecheck (how many groups have at least one pull request open).

#### Reviewing changes (everyone)
13. Assign a teammate to review your pull request, e.g. the person who created the issue).
14. Look at the pull request you were assigned to review. View (file diff in the) pull request to see what was changed.
15. Change to the pull request's branch and learn to find/navigate files.
16. Make a general comment on the pull request you are reviewing.
17. Make a comment on any line in the file in the pull request (submit it with "Add a single comment").

#### Approving changes (everyone)
18. Return to your pull request and read any comments left by others on yours. Click "Resolve conversation" on the comments (if everything is alright!)

#### Merging changes (everyone)
19. Merge your own branch into `master`.

#### Clean up (everyone)
20. Delete your merged branch.

:tada::tada::tada::tada::tada:
1 change: 1 addition & 0 deletions slides/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Slides