Skip to content

Commit 015a84b

Browse files
authored
Address review feedback on draft PR guidelines formatting and content
1 parent 18f4a5e commit 015a84b

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -160,26 +160,32 @@ GitHub allows you to mark a pull request as a [draft](https://docs.github.com/en
160160
A draft PR indicates that:
161161
- The changes are **not yet ready for submission/merging** (e.g., work is still in progress, tests are incomplete, or functionality is not fully working).
162162
- You are **seeking early feedback** from the community on your approach, design decisions, or implementation.
163+
**Important:** Clearly state in the PR description what kind of feedback you are seeking, as draft PRs may be overlooked until marked as ready for review.
163164
- You may need **help or guidance** to resolve specific issues or to complete the work.
164165
- You want to **share your progress** with others who might be interested or affected by the changes.
165166

166167
#### What Draft Status Does NOT Mean
167168

168169
A draft PR is **not**:
169-
- A place to dump incomplete or unclear changes without context. Every PR, including drafts, should have a clear purpose and description.
170-
- A shield against comments or reviews. Marking a PR as draft does not mean "leave me alone" – it means you welcome early feedback and collaboration.
171-
- A substitute for local development or working in a private branch. If you're not ready to share your work or discuss it with others, keep it in your local repository or in a branch of your fork without creating a PR.
170+
- A place to dump incomplete or unclear changes without context.
171+
Every PR, including drafts, should have a clear purpose and description.
172+
- A shield against comments or reviews.
173+
Marking a PR as draft does not mean "leave me alone" – it means you welcome early feedback and collaboration.
174+
- A substitute for local development or working in a private branch.
175+
If you're not ready to share your work or discuss it with others, keep it in your local repository or in a branch of your fork without creating a PR.
172176

173177
#### Requirements for Draft PRs
174178

175179
Even when marked as a draft, your PR should meet these basic requirements:
176180

177181
- **Clear intent and description**: Explain what you are trying to achieve, why the changes are being made, and what the current state is.
178-
- **Understandable changes**: Others should be able to understand what you have done so far and what remains to be done. Consider using a task list in the description to track progress.
179-
- **Specific questions or requests**: If you need help or feedback on particular aspects, clearly state what you need (_e.g._, "I'm unsure about the approach in XYZ.java" or "Tests for feature X are still missing").
182+
- **Understandable changes**: Others should be able to understand what you have done so far and what remains to be done.
183+
Consider using a task list in the description to track progress.
184+
- **Specific questions or requests**: If you need help or feedback on particular aspects, clearly state what you need (e.g., "I'm unsure about the approach in XYZ.java" or "Tests for feature X are still missing").
180185
- **Reasonable completeness**: While not everything needs to be finished, the PR should represent a coherent chunk of work that others can review and comment on meaningfully.
181186

182-
When your draft PR is ready for final review, convert it to a regular PR using the "Ready for review" button. At that point, it should meet all the criteria from the [What does a valid PR look like?](#what-does-a-valid-pr-look-like-checklist) checklist above.
187+
When your draft PR is ready for final review, convert it to a regular PR using the "Ready for review" button.
188+
At that point, it should meet all the criteria from the [What does a valid PR look like?](#what-does-a-valid-pr-look-like-checklist) checklist above.
183189

184190
## Commit Message Recommendations
185191

0 commit comments

Comments
 (0)