diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e579e76..f12f086 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -160,26 +160,32 @@ GitHub allows you to mark a pull request as a [draft](https://docs.github.com/en A draft PR indicates that: - 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). - You are **seeking early feedback** from the community on your approach, design decisions, or implementation. + **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. - You may need **help or guidance** to resolve specific issues or to complete the work. - You want to **share your progress** with others who might be interested or affected by the changes. #### What Draft Status Does NOT Mean A draft PR is **not**: -- A place to dump incomplete or unclear changes without context. Every PR, including drafts, should have a clear purpose and description. -- 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. -- 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. +- A place to dump incomplete or unclear changes without context. + Every PR, including drafts, should have a clear purpose and description. +- 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. +- 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. #### Requirements for Draft PRs Even when marked as a draft, your PR should meet these basic requirements: - **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"). +- **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"). - **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. -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. +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. ## Commit Message Recommendations