Skip to content

Commit

Permalink
WELCOME.md: warn new users against copy/pastign CC lists
Browse files Browse the repository at this point in the history
Copy/pasting Markdown-formatted CC lists from one GGG PR to another can
result in a broken CC list which needs manual fixing from the
maintainer. So warn users about this issue early on for all first-time
contributors.

See [1] for a discussion of some of the ways the community would like to
mitigate this issue (one of which is the motivation for this change).

[1] https://lore.kernel.org/git/[email protected]/
  • Loading branch information
listx committed Jun 30, 2024
1 parent 7152632 commit 59c9121
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions res/WELCOME.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ You can CC potential reviewers by adding a footer to the PR description with the

CC: Revi Ewer <[email protected]>, Ill Takalook <[email protected]>

NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description,
because it will result in a malformed CC list on the mailing list. See
[example](https://lore.kernel.org/git/[email protected]/).

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

* the lines should not exceed 76 columns,
Expand Down

0 comments on commit 59c9121

Please sign in to comment.