Skip to content

Commit 7eda256

Browse files
authored
docs: explain PR conventions a bit more (#20332)
We have conventions around title and content of bug and feature PRs that we didn't explain clearly enough in the contributing guide. Clarify a little more. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent e9de4e9 commit 7eda256

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

CONTRIBUTING.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -326,12 +326,17 @@ $ yarn watch & # runs in the background
326326
[conventionalcommits](https://www.conventionalcommits.org).
327327
* The title must begin with `feat(module): title`, `fix(module): title`, `refactor(module): title` or
328328
`chore(module): title`.
329+
* Titles for `feat` and `fix` PRs end up in the change log. Think about what makes most sense for users reading the changelog while writing them.
330+
* `feat`: describe the feature (not the action of creating the commit or PR, for example, avoid words like "added" or "changed")
331+
* `fix`: describe the bug (not the solution)
329332
* Title should be lowercase.
330333
* No period at the end of the title.
331334

332-
* Pull request message should describe _motivation_. Think about your code reviewers and what information they need in
335+
* Pull request body should describe _motivation_. Think about your code reviewers and what information they need in
333336
order to understand what you did. If it's a big commit (hopefully not), try to provide some good entry points so
334337
it will be easier to follow.
338+
* For bugs, describe bug, root cause, solution, potential alternatives considered but discarded.
339+
* For features, describe use case, most salient design aspects (especially if new), potential alternatives.
335340

336341
* Pull request message should indicate which issues are fixed: `fixes #<issue>` or `closes #<issue>`.
337342

0 commit comments

Comments
 (0)