[DOC] Update the guidelines on linked issues/PRs
Open
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- Python
- Stars
- 3
- Forks
- 2
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 3
Description
The mention of "closes #issue number" is not always reliable in cases where the specific formatting is not matched.
We should add a sentence on using the "development" section in the right hand menu bar to properly link issues and pull requests.
Contributor guide
No contributing guide indexed for this repository
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
No file or test is named in the issue; first locate the documentation section covering linked issues and pull requests. Done means the guidance explains using the Development section in the right-hand sidebar to link issues and pull requests, alongside the existing mention of "closes #issue number".
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100