CONTRIBUTING.md not created or staged when it is brought up in chapter 2.2
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 50/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- git
- Domain
- documentation
Research direction
Review chapter 2.2, especially the section on staging modified files and its CONTRIBUTING.md example. Check the walkthrough from a fresh reader’s perspective, then ensure the text explicitly accounts for creating and staging the file. Done means the instructions can be followed without an unstated step.
Written by the indexing model from the issue text.
Description
General overview of your idea.
Maybe I am being dense, but if I am not mistaken. In chapter 2.2 under staging modified files. CONTRIBUTING.md is brought up, yet no such file has been created at this point and neither has it been staged yet.
Doing so is very straightforward but...
Let’s change a file that was already tracked. If you change a previously tracked file called
CONTRIBUTING.mdand then run your git status command again, you get something that looks like this:
...does not imply that you need to do these steps. Rather it implies that the reader has missed a step and should already have a created and staged CONTRIBUTING.md file.
A solution would be a snippet of code to create and stage CONTRIBUTING.md or explicit instructions to make and stage such a file in the text.
It goes without saying but thanks for the great resource. :)
What problem will this solve?
re-enable the reader to follow along with the instructions provided by the book.
Have you thought about other solutions?
Another solution would be to more explicitely tell the user to create and stage the CONTRIBUTING.md themselves.
Do you want to help with this enhancement idea?
No
- 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 72/100
-
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
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
git/git-scm.com#2207 ·
-
link-check link-check:sphinx-theme
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
qgis/QGIS-Documentation#11275 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
CSCfi/sd-search-api#39 ·
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 85/100