Update Chapter 2.4 "Undoing Things" to mention git rm --cached for unstaging files
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- git
- Domain
- documentation
Research direction
Start with Chapter 2, Section 4, “Undoing Things,” and compare its unstaging commands with current Git guidance. Update the textbook commands to clarify the modern unstaging method and retain a brief note about legacy git reset usage; done when the section consistently reflects the intended command guidance.
Written by the indexing model from the issue text.
Description
There's no existing/similar bug report.
- I have searched the existing issues
This report is about a single actionable bug.
- I'm reporting a single actionable bug
This report is about the ProGit book, version 2, English language.
- This bug is not about a translation or old version
Bug covers book website/pdf
- I confirm the bug is about the book as found on the website/pdf
Problem is present in the Pro Git book on the website?
- This bug also affects the Pro Git book as published on the website.
Which version of the book is affected?
I don't know
Describe the bug:
While reading through the book, I noticed that Chapter 2, Section 4 ("Undoing Things") heavily relies on git reset HEAD ... to demonstrate how to unstage a file. While git reset still works for backwards compatibility, modern versions of Git (v2.23+) now explicitly output (use "git rm --cached ..." to unstage) when running git status. To ensure the text aligns with modern terminal hints and best practices, it would be highly beneficial to update this section to prioritize git restore --staged as the primary method for unstaging, while keeping a brief note about legacy git reset functionality.
Expected behavior:
Commands to be updated in the textbook
- Dominant language
- CSS
- Stars
- 6.6k
- Forks
- 2.1k
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from progit/progit2
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
enhancement
Difficulty 1/5 1-3 hours Newbie friendliness 65/100
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 62/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Similar issues
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agilepathway/label-checker#640 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
BasedHardware/omi#15662 · 1 comment ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100