Skip to content

Commit e452785

Browse files
docs: clarify how PR titles should be formatted (grafana#49682)
1 parent 50538d5 commit e452785

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

contribute/create-pull-request.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,14 @@ If you're unsure, see the existing [changelog](https://github.com/grafana/grafan
117117

118118
### Pull request titles
119119

120+
The pull request title should be formatted according to `<Area>: <Summary>` (Both "Area" and "Summary" should start with a capital letter).
121+
120122
The Grafana team _squashes_ all commits into one when we accept a pull request. The title of the pull request becomes the subject line of the squashed commit message. We still encourage contributors to write informative commit messages, as they becomes a part of the Git commit body.
121123

122124
We use the pull request title when we generate change logs for releases. As such, we strive to make the title as informative as possible.
123125

124-
Make sure that the title for your pull request uses the same format as the subject line in the commit message.
126+
**Example:**
127+
`Docs: Change url to URL in all documentation files`
125128

126129
## Configuration changes
127130

contribute/merge-pull-request.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,15 @@ Before you can merge a pull request, it must have a review approval, and all the
2727

2828
### Format the pull request title
2929

30-
The pull request title should be formatted according to `<Area>: <Summary>`. Keep the summary short and understandable for the community as a whole.
30+
The pull request title should be formatted according to `<Area>: <Summary>` (Both "Area" and "Summary" should start with a capital letter).
31+
32+
Keep the summary short and understandable for the community as a whole.
3133

3234
All commits in a pull request are squashed when merged and the pull request title will be the default subject line of the squashed commit message. It's also used for [changelog/release notes](#include-in-changelog-and-release-notes).
3335

36+
**Example:**
37+
`Docs: Change url to URL in all documentation files`
38+
3439
See [formatting guidelines](create-pull-request.md#formatting-guidelines) for more information.
3540

3641
### Assign a milestone

0 commit comments

Comments
 (0)