Contributing to Pro Git (CONTRIBUTING.md): Conflates issues and issue reports

Open
#2,001 0 comments 0 reactions 0 assignees View on GitHub

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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from progit/progit2

All issues in progit/progit2

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.