Document guidelines for opening and reviewing issues and PRs
Nobody has claimed this yet.
- Dominant language
- JSON
- Stars
- 5.8k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 186
Description
This is a follow up to #4024.
As a reviewer, I want to have a written set of PR and issue reviewing guidelines and best practices to refer to, so I can review and respond to issues and PRs more fairly and consistently.
As a contributor, I want to have a written set of PR and issue guidelines and best practices, so I can get my PRs merged and issues accepted faster.
Acceptance criteria:
- Add subsections to
contributing.md#opening-issues-and-pull-requestsfor submitter and reviewer guidelines - Include a few known guidelines and practices (e.g., welcome new contributors, wait times before pushing to a contributor's branch, CI must pass, etc.)
- Add a link to the guidelines from
.github/PULL_REQUEST_TEMPLATE(maybe?)
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.
Research direction
Start by reading docs/contributing.md at the “Opening issues and pull requests” section and the .github/PULL_REQUEST_TEMPLATE file. Add submitter and reviewer guidelines covering the listed practices, and link to them from the pull request template if appropriate. Done means all three acceptance criteria are addressed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100