[PATCH v3 0/8] docs: recommend using contrib/contacts/git-contacts
- From
- Linus Arver via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Apr 9, 2024, 21:56 UTC
- Message-ID
- <pull.1704.v3.git.1712699815.gitgitgadget@gmail.com>
- In-Reply-To
- <pull.1704.v2.git.1712366536.gitgitgadget@gmail.com>
Make git-contacts more prominent in our docs.
Notable changes in v3 =====================
* Refer to GitGitGadget via a link to MyFirstContribution (instead of sending readers to GGG's homepage directly) * Soften the advice for using git-contacts
Notable changes in v2 =====================
* Improve existing mention of git-contacts in SubmittingPatches (instead of adding a separate, entirely new paragraph) * Add example usage of integrating git-contacts with git-send-email with the latter's --cc-cmd flag. * Various smaller fixes to SubmittingPatches
Linus Arver (8): MyFirstContribution: mention contrib/contacts/git-contacts SubmittingPatches: make 'git contacts' grep-friendly SubmittingPatches: mention GitGitGadget SubmittingPatches: quote commands SubmittingPatches: discuss reviewers first SubmittingPatches: dedupe discussion of security patches SubmittingPatches: add heading for format-patch and send-email SubmittingPatches: demonstrate using git-contacts with git-send-email
Documentation/MyFirstContribution.txt | 5 ++ Documentation/SubmittingPatches | 68 +++++++++++++++------------ 2 files changed, 43 insertions(+), 30 deletions(-)
base-commit: c2cbfbd2e28cbe27c194d62183b42f27a6a5bb87 Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1704%2Flistx%2Freviewers-v3 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1704/listx/reviewers-v3 Pull-Request: https://github.com/gitgitgadget/git/pull/1704
Range-diff vs v2:
1: 3817e7f3cd0 ! 1: 1f65dc5ba3d MyFirstContribution: mention contrib/contacts/git-contacts
@@ Documentation/MyFirstContribution.txt: $ git send-email --to=target@example.com
NOTE: Check `git help send-email` for some other options which you may find
valuable, such as changing the Reply-to address or adding more CC and BCC lines.
-+NOTE: Use `contrib/contacts/git-contacts` to get a list of reviewers you should
-+include in the CC list. In addition, you can do `git send-email --cc-cmd='git
-+contacts' feature/*.patch` to automatically pass this list of emails to
-+`send-email`.
++NOTE: If you're not sure who to CC, use `contrib/contacts/git-contacts` to get a
++list of reviewers you should include in the CC list. In addition, you can do
++`git send-email --cc-cmd='git contacts' feature/*.patch` to automatically pass
++this list of emails to `send-email`.
+
NOTE: When you are sending a real patch, it will go to git@vger.kernel.org - but
please don't send your patchset from the tutorial to the real mailing list! For
2: 82e5e05288d = 2: 6e8b1b50ac5 SubmittingPatches: make 'git contacts' grep-friendly
3: 6e6950afa6e ! 3: 7f8fdc053f7 SubmittingPatches: mention GitGitGadget
@@ Documentation/SubmittingPatches: are optimized for the workflow of sending patch
your existing e-mail client (often optimized for "multipart/*" MIME
type e-mails) might render your patches unusable.
-+NOTE: You can also use GitGitGadget (https://gitgitgadget.github.io/) to send in
-+your patches. The discussion here focuses on using `format-patch` and
-+`send-email`.
++NOTE: Here we outline the procedure using `format-patch` and
++`send-email`, but you can instead use GitGitGadget to send in your
++patches (see link:MyFirstContribution.html[MyFirstContribution]).
+
People on the Git mailing list need to be able to read and
comment on the changes you are submitting. It is important for
4: fb06d5ce247 = 4: ef26bdb75c5 SubmittingPatches: quote commands
5: a8abcf45881 = 5: 6f71b1731f2 SubmittingPatches: discuss reviewers first
6: 326afe13315 = 6: f5e44f69941 SubmittingPatches: dedupe discussion of security patches
7: 09f4e7ad123 = 7: e64fc5c888a SubmittingPatches: add heading for format-patch and send-email
8: b35748f0cf8 = 8: 4fcab0d3319 SubmittingPatches: demonstrate using git-contacts with git-send-email-- gitgitgadget