RE: [PATCH v1] Writing down mail list etiquette.

[Felipe Contreras <felipe.contreras@gmail.com>]

Dave Huseby wrote:
> After violating a few unspoken etiquette rules that were spotted by
> Christian Couder <christian.couder@gmail.com>, Filipe Contreras
> <felipe.contreras@gmail.com> suggested that somebody write a guide.

Thanks for doing this. It's hard for seasoned developers to spot the
gaps in documentation, and that's why it's so important for newcomers to
fill them before they themselve get too accustomed with the project.

> --- /dev/null
> +++ b/Documentation/MailingListEtiquette.txt
> @@ -0,0 +1,125 @@
> +Mailing List Etiquette
> +======================
> +
> +[[introduction]]
> +== Introduction
> +
> +Open source, community projects such as Git use a mailing list and email to
> +coordinate development and to submit patches for review. This article documents
> +the unspoken rules and etiquette for the proper way to send email to the
> +mailing list. What follows are considered best practices to follow.

  Some open source projects--such as Git--use email to...

Some open source projects do, certainly not all.

> +If you are looking for details on how to submit a patch, that is documented
> +elsewhere in:
> +
> +- `Documentation/SubmittingPatches`
> +- `Documentation/MyFirstContribution.txt`
> +
> +[[proper-use-of-to-and-cc]]
> +== Proper Use of To and Cc
> +
> +When starting a new email thread that is not directed at any specific person,
> +put the mailing list address in the "To:" field, otherwise address it to the
> +person and put the mailing list address in the "Cc:" field.
> +
> +When replying to an email on the mailing list, put the person you are replying
> +to in the "To:" field and all other people in the thread in the "Cc:" field,
> +including the mailing list address.
> +
> +Make sure to keep everyone involved in the "Cc:" field so that they do not have
> +to be subscribed to the mailing list to receive replies.

Although all this is OK, I don't think it matters much who you put in
Cc, and who in the To fields.

As long as everyone involved--including the mailing list--is in both
fields, you are fine.

> +[[do-not-use-mail-followup-to]]
> +== Do Not Use Mail-Followup-To

Er, this is improtant, but it shouldn't be #2.

There's a lot of things more important than this, for example something
I encountered recently...

  Do not top-post [1], and try to remove as much context as possible.
  Only leave the context that is important for your reply.

In fact, this opens the possiblity for some much needed levity...

  A: Because it messes up the order in which people normally read text.
  Q: Why is top-posting such a bad thing?
  A: Top-posting.
  Q: What is the most annoying thing in e-mail?

This is especially important for people coming from corporate
environments where top-posting is the norm, and no context is ever
deleted.

[1] https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

> +[[enable-plain-text-mode]]
> +== Enable Plain Text Mode
> +
> +Most email clients automatically reject mailing list email if it is not a
> +text/plain formatted email.

It's not the email clients, it's the mailing list software itself.

Either way this is important.

> +[[patches-that-receive-no-response]]
> +
> +From Junio's notes from the maintainer:
> +
> +> If you sent a patch and you did not hear any response from anybody for
> +> several days, it could be that your patch was totally uninteresting,
> +> but it also is possible that it was simply lost in the noise.  Please
> +> do not hesitate to send a reminder message in such a case.  Messages
> +> getting lost in the noise may be a sign that those who can evaluate
> +> your patch don't have enough mental/time bandwidth to process them
> +> right at the moment, and it often helps to wait until the list traffic
> +> becomes calmer before sending such a reminder.

This is important for other mails, like bug reports, and questions, not
just patches.


Another very general aspect of the git mailing list (and others
similar), is that you should never be afraid of simply sending a
point-blank mail to the mailinsg list.

You don't need to subscribe, and you don't need to look for people to
Cc... Just send the mail.

It's generally better to just send the mail than not send it (even if
people like Dave are bitten by their configuration).

Cheers.

-- 
Felipe Contreras