-
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
Conversation
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.
|
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.
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? |
|
Merging this PR to establish clear draft PR guidelines. Reason: We're seeing recurring cases where draft PRs lack sufficient context for reviewers to understand the intent and changes (most recent example: eclipse-pde/eclipse.pde#2204 - draft PR with title "Classpath computation" but no description). This makes it difficult for maintainers to provide meaningful feedback or assess the direction, even for work-in-progress. The guidelines clarify:
This gives us a clear reference for future situations and helps contributors set expectations correctly, if anyone feels we need adjustments to this or other sections feel free to propose one. |
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
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.