Contributing to Pro Git (CONTRIBUTING.md): Conflates issues and issue reports
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- github
- Domain
- documentation
Research direction
Open CONTRIBUTING.md and review the Signaling an Issue and Small Corrections sections, starting with the cited wording. Update the terminology so issue reports are distinguished from issues and avoid duplicate tickets; done means the affected passages are clear and consistent.
Written by the indexing model from the issue text.
Description
CONTRIBUTING.md is confused/confusing, calling issue reports "issues" a few times, in the Signaling an Issue and Small Corrections sections.
The first occurrence is:
Search for similar issues, before creating a new issue.
I suggest rephrasing this as:
Before reporting an issue, search the tracker to try finding a pre-existing report. Avoid creating a duplicate ticket.
- Dominant language
- CSS
- Stars
- 6.6k
- Forks
- 2.1k
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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
-
Difficulty 1/5 Under an hour Newbie friendliness 87/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
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
Similar issues
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
AI-Agent/Queued Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 91/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
approved documentation
Difficulty 1/5 Under an hour Newbie friendliness 89/100
vitest-dev/vitest#12015 · 4 comments ·
Maintainers usually reply within 1 day
-
Pri3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
MicrosoftDocs/windows-dev-docs#6205 ·