Skip to content

Various small fixes#154

Merged
alexdewar merged 15 commits intomainfrom
fix-links-and-formatting
Jan 28, 2026
Merged

Various small fixes#154
alexdewar merged 15 commits intomainfrom
fix-links-and-formatting

Conversation

@alexdewar
Copy link
Copy Markdown

@alexdewar alexdewar commented Jan 28, 2026

The most important thing this PR fixes is a few broken links.

Besides that, I've also tweaked the formatting in a few places as well as changing the wording and fixing spellings etc. (most of these predate the transition to workbench).

I fixed some broken links in the CoC, but I think we probably want to change that file anyway (#146).

I've opened some issues for other small things.

Fixes #133. Fixes #138.

PS -- I've taken the liberty of updating the branch protection rule to include the new status checks.

@alexdewar alexdewar requested a review from Copilot January 28, 2026 11:29
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 28, 2026

Thank you!

Thank you for your pull request 😃

🤖 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:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/ImperialCollegeLondon/rse_further_git_course/compare/md-outputs..md-outputs-PR-154

The following changes were observed in the rendered markdown documents:

 00-course_overview.md               |  14 ++-----
 01-collaborating_with_git.md        |  28 +++++++-------
 02-branching_merging.md             |   8 ++--
 04-rewriting_history.md             |  71 ++++++++++++++++++------------------
 05-pulling_pushing.md               |   4 +-
 07-managing_contributions.md        |  51 ++++++++++++++------------
 08-continuous_integration.md        |  45 ++++++++++++-----------
 09-releases_tags.md                 |   2 +-
 10-collaborative_development.md     |   8 ++--
 CODE_OF_CONDUCT.md                  |   4 +-
 files/git-course-handout.pdf (new)  | Bin 0 -> 76570 bytes
 files/recipe_with_history.zip (new) | Bin 0 -> 26449 bytes
 md5sum.txt                          |  22 +++++------
 setup.md                            |   6 +--
 14 files changed, 132 insertions(+), 131 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.

⏱️ Updated at 2026-01-28 14:17:29 +0000

github-actions bot pushed a commit that referenced this pull request Jan 28, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR focuses on fixing broken internal/download links in the lesson materials and applying a set of small wording/formatting/spelling cleanups across multiple episodes.

Changes:

  • Fixes/updates several lesson links (e.g., setup instructions, handout link, CoC links).
  • Adds missing downloadable assets under episodes/files/ (handout PDF, recipe zip with history).
  • Applies consistent formatting/wording tweaks across multiple episodes (e.g., “GitHub” capitalization, punctuation, list formatting).

Reviewed changes

Copilot reviewed 11 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
learners/setup.md Updates the recipe zip download link (currently still mismatched to actual file location).
episodes/files/recipe_with_history.zip Adds recipe repository zip intended to include commit history for exercises.
episodes/files/git-course-handout.pdf Adds course handout PDF referenced from course overview.
episodes/10-collaborative_development.md Wording/capitalization and formatting cleanup.
episodes/09-releases_tags.md Fixes “GitHub” capitalization.
episodes/08-continuous_integration.md Formatting cleanup, terminology tweaks (“PRs”, “macOS”, UI label quoting).
episodes/07-managing_contributions.md Formatting cleanup and minor terminology standardization.
episodes/05-pulling_pushing.md Updates wording to use switch terminology and punctuation cleanup.
episodes/04-rewriting_history.md Fixes wording and updates setup-instructions link target.
episodes/02-branching_merging.md Formatting cleanup and wording clarification around main.
episodes/01-collaborating_with_git.md Formatting cleanup; contains a remaining typo (“need to need to”).
episodes/00-course_overview.md Fixes intro-course reference and updates setup/handout links.
CODE_OF_CONDUCT.md Updates Carpentries CoC/reporting links to new URLs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
github-actions bot pushed a commit that referenced this pull request Jan 28, 2026
github-actions bot pushed a commit that referenced this pull request Jan 28, 2026
Copy link
Copy Markdown

@AdrianDAlessandro AdrianDAlessandro left a comment

Choose a reason for hiding this comment

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

LGTM!

@alexdewar alexdewar merged commit e238981 into main Jan 28, 2026
4 checks passed
@alexdewar alexdewar deleted the fix-links-and-formatting branch January 28, 2026 14:17
github-actions bot pushed a commit that referenced this pull request Jan 28, 2026
github-actions bot pushed a commit that referenced this pull request Jan 28, 2026
Auto-generated via `{sandpaper}`
Source  : e238981
Branch  : main
Author  : Alex Dewar <alexdewar@users.noreply.github.com>
Time    : 2026-01-28 14:17:55 +0000
Message : Merge pull request #154 from ImperialCollegeLondon/fix-links-and-formatting

Various small fixes
github-actions bot pushed a commit that referenced this pull request Jan 28, 2026
Auto-generated via `{sandpaper}`
Source  : cba7850
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-01-28 14:18:44 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : e238981
Branch  : main
Author  : Alex Dewar <alexdewar@users.noreply.github.com>
Time    : 2026-01-28 14:17:55 +0000
Message : Merge pull request #154 from ImperialCollegeLondon/fix-links-and-formatting

Various small fixes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing file links The link to download the recipe zip does not work

3 participants