Skip to content

Commit 18f4a5e

Browse files
Copilotlaeubi
andauthored
Add draft PR guidelines to CONTRIBUTING.md
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>
1 parent 17f47a8 commit 18f4a5e

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,36 @@ When you have set up your fork of a repository that you want to contribute to an
151151
- After the PR is merged, the source branch used for the PR (in the fork) can be deleted.
152152
- Your fork is now _out-of-date_ with the main (upstream) project repository. In case the "origin" remote of your local clone is the forked repository, you should get it back up to date. You can either use the _Sync Fork_ function on GitHub to update the fork and pull the `master` branch to your local clone, or pull the latest changes from "upstream" (the main project repository) into your local repository.
153153

154+
### Using Draft Pull Requests
155+
156+
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.
157+
158+
#### What Draft Status Means
159+
160+
A draft PR indicates that:
161+
- 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).
162+
- You are **seeking early feedback** from the community on your approach, design decisions, or implementation.
163+
- You may need **help or guidance** to resolve specific issues or to complete the work.
164+
- You want to **share your progress** with others who might be interested or affected by the changes.
165+
166+
#### What Draft Status Does NOT Mean
167+
168+
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.
172+
173+
#### Requirements for Draft PRs
174+
175+
Even when marked as a draft, your PR should meet these basic requirements:
176+
177+
- **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").
180+
- **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.
181+
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.
183+
154184
## Commit Message Recommendations
155185

156186
```

0 commit comments

Comments
 (0)