From c19728dc204f7d58addb3d28ad12f77670648cff Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 10 Feb 2023 18:31:25 +0000 Subject: [PATCH] Add some advice on good PR titles (#24483) * Add some advice on good PR titles * Extra 'the' Co-authored-by: Germain --------- Co-authored-by: Germain --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd3ef7d63b..7c7dc57da4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 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) - Describe the why and what is changing in the PR description so it's easy for