chore: Addressing feedback after run through 2024-05-09

[ns-rse]

General

• Reorder episodes - Git Hygiene before branches so configuration can be addressed earlier and aliases set.
• Splits Branching > Branching / Diverging Branches / Additional Topics (worktree).

Setup

• Software Setup > Install Git.
• Remove line on explicitly installing pip in virtual env (pulled in as dependency).

Introduction

• Emphasise the pair-programming aspect of the challenges.
• Add note for instructor for when people have multiple Git accounts and need to explicitly set the SSH key.
• git fetch origin {divide,multiply,ns-rse/merge-conflict} branches so they are available before switching target of origin .

Git Hygiene

• Add section on using aliases (also here) to config with challenge to set an alias for pretty printing git log.
• Tpyos 1
• Tpyos 2
• Not regexs in .gitignore
• Create branch in .gitignore challenge/solution
• Tpyos ammend > amend
• Clarify addition/deletion under difftastic
• Remove garbage collection
• Tidy/clarify git ammend section
• Make example git commit --amend on python-maths
• Started section on force pushing and caveats

Branching

• Force spaces in section headers with inline code.
• Add missing space
• Tidying grammar
• Simpler solution for comparing branches after switching
• Clearer use of git logp alias
• Additional task to automatically delete branches on GitHub
• Update stashing challenge to work with python-maths and unstash on a different branch.

Diverging Branches

• Extended merge/rebase git graphs
• Show before graph next to merge/rebase
• Also added graphs to Challenge of merge/rebase on python-maths.
• Adds a challenge to resolve merge conflicts on python-maths.
• Callout for why rebase may be preferable over merge

Hooks

• git pull > git fetch in pre-push example
• Condense setup of env with pre-commit
• Tidy up Challenge 7 (and others)
• Remove cron for scheduling tidying

Additional Topics

• Move worktrees to additional topics.
• Move git rebase -x to additional topics.

[github-actions[bot]]

Thank you!

Thank you for your pull request :smiley:

:robot: This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

• :dart: correct output
• :framed_picture: correct figures
• :question: new warnings
• :bangbang: new errors

Rendered Changes

:mag: Inspect the changes: https://github.com/ns-rse/git-collaboration/compare/md-outputs..md-outputs-PR-78

The following changes were observed in the rendered markdown documents:

 additional_topics.md (new)  |  334 ++++++++++++
 branching.md                | 1263 ++++---------------------------------------
 config.yaml                 |    4 +-
 continuous_integration.md   |   14 +-
 diverging_branches.md (new) |  897 ++++++++++++++++++++++++++++++
 git_hygiene.md              |  258 +++++----
 hooks.md                    |  203 +++----
 index.md                    |    5 +-
 introduction.md             |   39 +-
 md5sum.txt                  |   18 +-
 setup.md                    |    6 +-
 11 files changed, 1635 insertions(+), 1406 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

:stopwatch: Updated at 2024-05-23 19:25:11 +0000