Add some advice on good PR titles (#24483)
* Add some advice on good PR titles * Extra 'the' Co-authored-by: Germain <germains@element.io> --------- Co-authored-by: Germain <germains@element.io>
This commit is contained in:
parent
087ecc8538
commit
c19728dc20
1 changed files with 8 additions and 1 deletions
|
@ -17,7 +17,14 @@ into our repo (https://help.github.com/articles/using-pull-requests/)
|
||||||
We use GitHub's pull request workflow to review the contribution, and either
|
We use GitHub's pull request workflow to review the contribution, and either
|
||||||
ask you to make any refinements needed or merge it and make them ourselves.
|
ask you to make any refinements needed or merge it and make them ourselves.
|
||||||
|
|
||||||
Things that should go into your PR description:
|
Your PR should have a title that describes what change is being made. This
|
||||||
|
is used for the text in the Changelog entry by default (see below), so a good
|
||||||
|
title will tell a user succinctly what change is being made. "Fix bug where
|
||||||
|
cows had five legs" and, "Add support for miniature horses" are examples of good
|
||||||
|
titles. Don't include an issue number here: that belongs in the description.
|
||||||
|
Definitely don't use the GitHub default of "Update file.ts".
|
||||||
|
|
||||||
|
As for your PR description, it should include these things:
|
||||||
|
|
||||||
- References to any bugs fixed by the change (in GitHub's `Fixes` notation)
|
- References to any bugs fixed by the change (in GitHub's `Fixes` notation)
|
||||||
- Describe the why and what is changing in the PR description so it's easy for
|
- Describe the why and what is changing in the PR description so it's easy for
|
||||||
|
|
Loading…
Reference in a new issue