Skip to content

Commit 4a05179

Browse files
retpolanneRomuloOliveira
authored andcommitted
Add an example from the LKML regarding good cover letters
[1] contains an example of a great cover letter for a patchset that was sent on the LKML (Linux Kernel Mailing List). Add this example and a breakdown of it to the notes. [1] https://lore.kernel.org/lkml/20230414225551.858160935@linutronix.de/ Signed-off-by: Anne Macedo <annie@retpolanne.com>
1 parent 913228c commit 4a05179

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,20 @@ together.
261261
If you're writing a smaller (single or a few commits) change, treat the first commit as a cover letter.
262262
Github, for example, uses this first commit as the default PR message.
263263

264+
Here's an [example](https://lore.kernel.org/lkml/20230414225551.858160935@linutronix.de/) of a good cover
265+
letter sent on the Linux kernel mailing list. It contains:
266+
267+
- A description of the overall changes and why they were made;
268+
269+
- Background, or any important information that is needed to understand these changes;
270+
271+
- A breakdown of the solution and the approach taken to reach such solution;
272+
273+
- Caveats, or things that could go wrong and must be considered before applying such changes;
274+
275+
- Possible enhancements, a section describing opportunities for future changes that are out of the scope
276+
for the current commit set;
277+
264278
## Rebase vs. Merge
265279

266280
This section is a **TL;DR** of Atlassian's excellent tutorial, ["Merging vs. Rebasing"](https://www.atlassian.com/git/tutorials/merging-vs-rebasing).

0 commit comments

Comments
 (0)