au-research / github-training Goto Github PK

Diffs are pretty important.

The jargon is a lot to get the hang of and the training leaps right into it without much background - would be good to have a glossary for reference during and after the training, especially for those unfamiliar with github, etc.

We could borrow this stuff from the Carpentries Git lesson

• Remove list of jargon
• Explain difference between git and github (and gitlab/bitbucket maybe?; issue #6)
• Introduce concept of version control (issue #7)

Add a screenshot for the demonstration activity.

This template
https://readme.so/

might be useful for
https://au-research.github.io/github-training/3-editing-a-file
also, please check URLs the first 2 links are broken

The episode timings and learning objectives don't render correctly due to poor markdown.

If this stays at 4 hours, I think we should adjust timings to be 1 hour total break time, eg 15 mins plus 45 mins.
Considering how we might typically run this for 4 timezones

| 9-1 | WA |
| 10:30 - 2:30 | SA, NT |
| 11-2 | Eastern states |
| 1-5 | NZ |

• Explicitly use terms "base" and "head" repository rather than "upstream"
• Add screenshots of creating a pull request
• Add screenshots of reviewing and merging a pull request
• Add demonstrations of creating pull request and merging a pull request

• Fix markdown
• Add unrendered markdown code block followed by rendered example
• Add screenshots to demonstrate process of editing a file
• Add a screenshot to show what GitHub looks like if it's forked a repo for you
• Add information about what makes a good commit message

• Prerequisites for teaching this workshop (aka what does the Instructor need to know)
• Suggested timings/breaks for different scenarios e.g. four hours intensive vs splitting up over several days

• Fix markdown
• Add reference to labels
• Add information on what makes a good issue title and description
• Screenshot the process of creating an issue (include checklist markdown)
• Add list of types of issues after discussion