Skip to content

Add details to the optional fork-and-PR challenge#181

Merged
alex-ball merged 2 commits intoLibraryCarpentry:mainfrom
alex-ball:patch-132
Aug 4, 2025
Merged

Add details to the optional fork-and-PR challenge#181
alex-ball merged 2 commits intoLibraryCarpentry:mainfrom
alex-ball:patch-132

Conversation

@alex-ball
Copy link
Copy Markdown
Contributor

This pull request addresses several issues with the optional challenge in Episode 5 to clone someone else's repository locally and use it to initiate a pull request:

  1. The heading and introductory paragraph should be inside the challenge fenced div, not before it in a block quote.
  2. The introductory paragraph should explain why someone would want to do it (issue Optional GitHub challenge needs expanding #132).
  3. Instead of taking learners through the steps directly, it tells them to look at an external set of instructions. But the external instructions aren't there any more (issue Broken link to "Time to Submit Your First PR" #175), and in any case involved forking an entirely different third party repository (which has since been removed).

The replacement text here fixes the formatting, adds some reasons why this workflow might be preferable, and provides a full set of steps that mirror the previous challenge, including screenshots.

I would welcome any improvements that can be made to these new steps.

Closes #132. Closes #175.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jul 8, 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/LibraryCarpentry/lc-git/compare/md-outputs..md-outputs-PR-181

The following changes were observed in the rendered markdown documents:

 05-github-pages.md               | 132 ++++++++++++++++++++++++++++++++++-----
 fig/github-fork-button.png (new) | Bin 0 -> 16809 bytes
 fig/github-fork-clone.png (new)  | Bin 0 -> 57518 bytes
 fig/github-pr-create.png (new)   | Bin 0 -> 27006 bytes
 md5sum.txt                       |   2 +-
 5 files changed, 117 insertions(+), 17 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-07-08 09:12:14 +0000

github-actions bot pushed a commit that referenced this pull request Jul 8, 2025
@alex-ball
Copy link
Copy Markdown
Contributor Author

@srerickson , do these changes look good to you?

@srerickson
Copy link
Copy Markdown
Contributor

Sorry for the delay-- this looks great!

@alex-ball alex-ball merged commit 7f0ab6b into LibraryCarpentry:main Aug 4, 2025
3 checks passed
@alex-ball alex-ball deleted the patch-132 branch August 4, 2025 08:24
github-actions bot pushed a commit that referenced this pull request Aug 4, 2025
Auto-generated via `{sandpaper}`
Source  : 7f0ab6b
Branch  : main
Author  : Alex Ball <alex-ball@users.noreply.github.com>
Time    : 2025-08-04 08:24:13 +0000
Message : Merge pull request #181 from alex-ball/patch-132

Improve optional fork-and-PR challenge:

1. Fix formatting of heading and introductory paragraph.
2. Explain motivation for this workflow.
3. Replace broken link with illustrated step-by-step instructions.
github-actions bot pushed a commit that referenced this pull request Aug 4, 2025
Auto-generated via `{sandpaper}`
Source  : c6aacdc
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-08-04 08:25:16 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 7f0ab6b
Branch  : main
Author  : Alex Ball <alex-ball@users.noreply.github.com>
Time    : 2025-08-04 08:24:13 +0000
Message : Merge pull request #181 from alex-ball/patch-132

Improve optional fork-and-PR challenge:

1. Fix formatting of heading and introductory paragraph.
2. Explain motivation for this workflow.
3. Replace broken link with illustrated step-by-step instructions.
github-actions bot pushed a commit that referenced this pull request Aug 5, 2025
Auto-generated via `{sandpaper}`
Source  : c6aacdc
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-08-04 08:25:16 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 7f0ab6b
Branch  : main
Author  : Alex Ball <alex-ball@users.noreply.github.com>
Time    : 2025-08-04 08:24:13 +0000
Message : Merge pull request #181 from alex-ball/patch-132

Improve optional fork-and-PR challenge:

1. Fix formatting of heading and introductory paragraph.
2. Explain motivation for this workflow.
3. Replace broken link with illustrated step-by-step instructions.
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.

Broken link to "Time to Submit Your First PR" Optional GitHub challenge needs expanding

2 participants