Skip to content

Commit dc24c32

Browse files
committed
Improve how to write a good pull request title and description
1 parent c733671 commit dc24c32

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/contributing/first-time.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,11 +196,12 @@ Once you have completed, tested, and linted your code, and created a {ref}`contr
196196
```
197197

198198
1. Visit your fork of the Plone repository on GitHub, and [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) against the development branch.
199-
- Make your title and description descriptive.
200-
- Include "Fixes #" and the related issue number.
199+
- Make both your title and description descriptive.
200+
Reviewers look at many pull requests, and need to quickly understand the context.
201+
A lazily written phrase such as "Fixes bug" is meaningless.
202+
- Include "Fixes #" and the related issue number in the description.
201203
This enables automatic closing of the related issue when the pull request is merged.
202204
This also creates a hyperlink to the original issue for easy reference.
203-
- Don't be lazy with "Fixes bug" or other useless drivel.
204205
1. [Request a review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review) from other team members.
205206
1. Members who subscribe to the repository will receive a notification and review your request.
206207

0 commit comments

Comments
 (0)