Update git diff explanation in history.md#1116
Update git diff explanation in history.md#1116johnschoneboom wants to merge 1 commit intoswcarpentry:mainfrom
Conversation
Clarified the explanation of the default option for 'git diff' and its behavior with staged files.
🆗 Pre-flight checks passed 😃This pull request has been checked and contains no modified workflow files, spoofing, or invalid commits. It should be safe to Approve and Run the workflows that need maintainer approval. |
|
Thank you for suggesting alternative text for the git diff explanation, I appreciate the thought you put into this. After digging into this further, including revisiting issue #1080, I think the better approach is to simplify the text here and clarify git diff more explicitly in episode 04, where it’s introduced. This episode is intended to focus on history and the use of identifiers and trying to capture the full variability of the git diff command here muddles the message. I’m going to close this PR and follow up with a new one that links back here so your contribution and the discussion aren’t lost :-) |
Clarified the explanation of the default option for 'git diff' and its behavior with staged files.
If this pull request addresses an open issue on the repository, please add 'Closes #NN' below, where NN is the issue number.
Please briefly summarise the changes made in the pull request, and the reason(s) for making these changes.
The Exploring History lesson asserted that HEAD was the default option for 'git diff', which is only true if the staging area is empty. If there are staged changes, 'git diff' compares the working area to the staged area, and adding HEAD will give a different result.
If any relevant discussions have taken place elsewhere, please provide links to these.
Details
For more guidance on how to contribute changes to a Carpentries project, please review the Contributing Guide and Code of Conduct.
Please keep in mind that lesson Maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact The Carpentries Team at team@carpentries.org.