Clarify issue/PR choreography
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 1k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 12
Description
From a discussion with @picnixz:
I think the problem with the devguide is the first sentence is "Create an issue that describes the change" and you'll see the mention to DPO only during creation. We can improve that
I would expect people to read the issue template correctly and understand that something is not trivial
and more importantly: WAIT for triagers to decide whether it's ok or not as an issue
There are obvious cases where the issue doesn't a triager for validation, like a clear bug (and even this is subject to interpretation sometimes) but the process issue+PR is the worst for triagers, especially when the PR is automated.
This might be a duplicate of other feedback here in issues, but I wanted to capture it before going back to $WORK.
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 locating the devguide’s opening instructions and the issue template, then review where DPO and triager guidance are introduced. Clarify that contributors should wait for triager validation before opening a PR, while noting the discussion around clear bugs. Done means the issue-to-PR workflow and exceptions are explicit to contributors.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100