-
Notifications
You must be signed in to change notification settings - Fork 15
Add draft PR guidelines to CONTRIBUTING.md #260
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Clarifies expectations for draft pull requests including: - What draft status means (seeking feedback, work in progress) - What it does NOT mean (not a shield from comments) - Requirements even for drafts (clear intent, understandable changes) - When to convert to regular PR Co-authored-by: laeubi <1331477+laeubi@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: laeubi <1331477+laeubi@users.noreply.github.com>
merks
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I totally agree with the premise being outlined. When a PR is created it should be comprehensible what the purpose is, not a private working area.
|
|
||
| ### Using Draft Pull Requests | ||
|
|
||
| GitHub allows you to mark a pull request as a [draft](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests) to indicate that it is not yet ready for final review or merging. Draft PRs are a valuable tool for collaboration, but they come with certain expectations in the Eclipse Platform community. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please start new sentence on new lines. Applies to all things below as well. For a bullets use
- This is is a bullet.
This the second sentence in the same bullet.
|
|
||
| - **Clear intent and description**: Explain what you are trying to achieve, why the changes are being made, and what the current state is. | ||
| - **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. | ||
| - **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"). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need for italics e.g.
|
Looks AI generated, way to long for this purpose. Also weird to have such longisch rules for draft PR and not for regular PR. Maybe just add a sentence like: "Draft PR indicate that they are WIP or not yet ready to merged but should follow the same quality rules as regular PR and it is OK to give feedback to them." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks AI generated, way to long for this purpose. Also weird to have such longisch rules for draft PR and not for regular PR.
Maybe just add a sentence like: "Draft PR indicate that they are WIP or not yet ready to merged but should follow the same quality rules as regular PR and it is OK to give feedback to them."
HeikoKlare
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this proposal. As we discussed offline already, from my point of view this should kind of reflect the expectations for every draft PR (no matter in which repo), but given that we repeatedly had the situation that PRs did not follow these expectations, it's good to have them documented. This is done in an clear and comprehensible way. I only have one comment for a potential improvement.
|
|
||
| #### What Draft Status Means | ||
|
|
||
| A draft PR indicates that: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be helpful to add a sentence that the PR creator should add information in the PR description on what kind of feedback is desired on that specific PR in the current state. Otherwise this description could lead to the assumption that one can expect early feedback for a draft PR, but usually most people will probably ignore draft PRs until they are marked as ready for review.
Please add concrete suggestions on changes you want "something like" is not really actionable. If someone things other sections are not detailed enough they can be improved in separate PRs. |
Feedback was: Looks AI generated, way to long for this purpose. Also weird to have such longisch rules for draft PR and not for regular PR. Maybe just add a sentence like: "Draft PR indicate that they are WIP or not yet ready to merged but should follow the same quality rules as regular PR and it is OK to give feedback to them." |
Maybe it was not clear enough, but please add code suggestions (like @merks and @HeikoKlare ) to suggest concrete changes on the text that can be addressed e.g.
Still if you have concrete proposals to shorten things without making it a generic short sentence that is open to interpretation and don't help people. A shorter form would be: |
|
Personally I'm fine with it either way, being it just a short paragraph or a verbose section explaining the details.
If your think that's important the section could also be about PRs in general and have smaller sub-section about drafts and what is different about them and what's not? |
Clarifies expectations for draft pull requests including:
There where recently some examples for this e.g.
And it feels it would be good to have a reference for the future with clear guidance.