Skip to content

Fix discrepancy in git instructions #462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

hsaunders1904
Copy link
Contributor

@hsaunders1904 hsaunders1904 commented May 29, 2025

Description

These are some changes I made to the slides when delivering section 3/4 of the course in March.
Changes are:

  • Fixed some out-of-date SSH addresses that still point to the UKAEA repository.
  • Removed a slide at the end of section 3 that instructs students to merge their working branch into develop. This caused some confusion in section 4, where, in the first exercise, students are asked to create a pull request containing their changes, but they'd already merged them.

Looking at the notes now, I see that it says to open a PR into main not develop, but there was definitely some confusion on the day. It may have been my fault!

I need to check through the course notes to find the right answer here, but don't have the time right now. I'll try to have a look in the next few days.

The first task in section 4 is a code review exercise, which instructs
the students to open a pull request on GitHub. However, this slide
at the end of section 3 instructs the students to merge their changes
into develop locally.

This caused some confusion last time I ran this, as the students had no
existing changes to make a pull request from!
Copy link

github-actions bot commented May 29, 2025

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/carpentries-incubator/python-intermediate-development/compare/md-outputs..md-outputs-PR-462

The following changes were observed in the rendered markdown documents:

 common-issues.md                    |  2 +-
 md5sum.txt                          |  4 ++--
 section_4_collaborative_soft_dev.md | 10 +++++-----
 3 files changed, 8 insertions(+), 8 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 2025-05-30 16:17:39 +0000

github-actions bot pushed a commit that referenced this pull request May 30, 2025
@bielsnohr
Copy link
Collaborator

Going to keep #458 open and make #464 be the one that closes it.

github-actions bot pushed a commit that referenced this pull request May 30, 2025
@bielsnohr bielsnohr merged commit 5ac731f into carpentries-incubator:main May 30, 2025
3 checks passed
github-actions bot pushed a commit that referenced this pull request May 30, 2025
Auto-generated via `{sandpaper}`
Source  : 5ac731f
Branch  : main
Author  : Matthew <6177028+bielsnohr@users.noreply.github.com>
Time    : 2025-05-30 16:18:18 +0000
Message : Merge pull request #462 from hsaunders1904/458_fix_discrepancy_in_git_instructions

Correct links and a typo in slides of section 3/4
github-actions bot pushed a commit that referenced this pull request May 30, 2025
Auto-generated via `{sandpaper}`
Source  : 1169914
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-05-30 16:19:05 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5ac731f
Branch  : main
Author  : Matthew <6177028+bielsnohr@users.noreply.github.com>
Time    : 2025-05-30 16:18:18 +0000
Message : Merge pull request #462 from hsaunders1904/458_fix_discrepancy_in_git_instructions

Correct links and a typo in slides of section 3/4
github-actions bot pushed a commit that referenced this pull request Jun 3, 2025
Auto-generated via `{sandpaper}`
Source  : 1169914
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-05-30 16:19:05 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5ac731f
Branch  : main
Author  : Matthew <6177028+bielsnohr@users.noreply.github.com>
Time    : 2025-05-30 16:18:18 +0000
Message : Merge pull request #462 from hsaunders1904/458_fix_discrepancy_in_git_instructions

Correct links and a typo in slides of section 3/4
github-actions bot pushed a commit that referenced this pull request Jun 10, 2025
Auto-generated via `{sandpaper}`
Source  : 1169914
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-05-30 16:19:05 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5ac731f
Branch  : main
Author  : Matthew <6177028+bielsnohr@users.noreply.github.com>
Time    : 2025-05-30 16:18:18 +0000
Message : Merge pull request #462 from hsaunders1904/458_fix_discrepancy_in_git_instructions

Correct links and a typo in slides of section 3/4
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.

3 participants