Commit 099ddc5
committed
Add section to PR guide on titles and descriptions
Add a short section to the PR guide which covers good titles and
descriptions, at a summary level.
The priority here is (in presentation order):
- explain the rationale / why we care
- demonstrate how a PR title should look
- give some hint as to what a good description will look like
Explaining how to write good technical prose for a PR description is
considered out of scope, which limits the content of the PR description
section.1 parent 0164145 commit 099ddc5
1 file changed
Lines changed: 18 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
203 | 203 | | |
204 | 204 | | |
205 | 205 | | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
206 | 224 | | |
207 | 225 | | |
208 | 226 | | |
| |||
0 commit comments