Skip to content

Conversation

@alex-ball
Copy link
Contributor

The explanation of the staging area in episode 2 was reproduced from the Software Carpentry Git Novice lesson. The original wording relied on people reading "snapshot" in just the photographic sense, and understanding "the extra" in sense of an archetype ("you know, that guy"). But people may also be familiar with other senses of "snapshot", and I for one thought that an earlier introduction to this extra had been accidentally deleted.

The text has since been clarified in the Software Carpentry lesson. This PR reproduces edits made in swcarpentry/git-novice@e6fe3e6 from PR swcarpentry/git-novice#707 (credit to @vyasr).

Reproduces edits made in /swcarpentry/git-novice@e6fe3e6 from PR /swcarpentry/git-novice#707.
@alex-ball alex-ball added the type:clarification Suggest change for make lesson clearer label Aug 28, 2025
@github-actions
Copy link

github-actions bot commented Aug 28, 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-189

The following changes were observed in the rendered markdown documents:

 02-getting-started.md | 8 ++++----
 md5sum.txt            | 2 +-
 2 files changed, 5 insertions(+), 5 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-08-28 11:21:37 +0000

github-actions bot pushed a commit that referenced this pull request Aug 28, 2025
@srerickson
Copy link
Contributor

lgtm!

@srerickson srerickson assigned alex-ball and unassigned srerickson Sep 2, 2025
@alex-ball alex-ball merged commit fa839a5 into LibraryCarpentry:main Sep 3, 2025
3 checks passed
github-actions bot pushed a commit that referenced this pull request Sep 3, 2025
Auto-generated via `{sandpaper}`
Source  : fa839a5
Branch  : main
Author  : Alex Ball <alex-ball@users.noreply.github.com>
Time    : 2025-09-03 08:32:48 +0000
Message : Merge pull request #189 from alex-ball/patch-189

Clarify explanation of staging area
github-actions bot pushed a commit that referenced this pull request Sep 3, 2025
Auto-generated via `{sandpaper}`
Source  : e7c5cab
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-09-03 08:36:23 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : fa839a5
Branch  : main
Author  : Alex Ball <alex-ball@users.noreply.github.com>
Time    : 2025-09-03 08:32:48 +0000
Message : Merge pull request #189 from alex-ball/patch-189

Clarify explanation of staging area
@alex-ball alex-ball deleted the patch-189 branch September 3, 2025 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:clarification Suggest change for make lesson clearer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants