site/wiki/pages/mailing_lists.md

120 lines
4.8 KiB
Markdown
Raw Permalink Normal View History

2018-12-14 14:43:03 +00:00
---
author: ~erxeto
published: true
2022-02-16 17:33:28 +00:00
title: mailing list netiquette
2022-06-14 23:12:00 +00:00
description: tildeverse mailing lists etiquette guide
2018-12-14 14:43:03 +00:00
category:
2022-09-29 18:53:09 +00:00
- beginners
- guidelines
2018-12-14 17:06:39 +00:00
---
2018-12-14 14:43:03 +00:00
the tildeverse has now its own mailing list service. you can take a look at:
2018-12-14 17:06:39 +00:00
[lists.tildeverse.org](https://lists.tildeverse.org/)
2018-12-14 14:43:03 +00:00
this is a description of the basic *netiquette* rules for this service. most of
2022-09-29 18:53:09 +00:00
the text is taken shamelessly from
2018-12-14 17:06:39 +00:00
[man.sr.ht/lists.sr.ht/etiquette.md](https://man.sr.ht/lists.sr.ht/etiquette.md)
2018-12-14 14:43:03 +00:00
with some adaptations and a couple more suggestions taken from other lists out
there.
some email clients have popularized email usage patterns which are considered
poor form on many mailing lists. please review some of our suggestions for
2022-09-29 18:53:09 +00:00
participating more smoothly in discussions on the tildeverse. this advice will
likely serve you well outside the tildeverse as well.
2018-12-14 14:43:03 +00:00
if you have any troubles following these guides or don't know how to configure
your email client for this purpose, ask on irc (#meta or #team), you'll find
2018-12-14 14:43:03 +00:00
always somebody willing to help.
## plain text
2018-12-14 14:43:03 +00:00
please make sure that your email client is configured to use plain text emails.
by default, many email clients compose emails with HTML, so you can use rich
text formatting. rich text is not desirable for mailing lists. keep in mind that
some people uses console email clients without html rendering support. also,
2018-12-14 14:43:03 +00:00
people with high volume of emails may pre-process them and html is not good for
that. so you should disable this feature and send your email as "plain text".
every email client is different, you should research the options for your
2018-12-14 14:43:03 +00:00
specific client.
## top-posting
2018-12-14 14:43:03 +00:00
some email clients will paste the entire email you're replying to into your
response and encourage you to write your message over it. this behavior is
2018-12-14 14:43:03 +00:00
called "top posting" and is discouraged on the tildeverse lists (or on any
mailing list really). instead, cut out any parts of the reply that you're not
2022-09-29 18:53:09 +00:00
directly responding to and write your comments inline. feel free to edit the
original message as much as you like. in other words, keep the relevant context
for your reply and delete the rest. this makes cleaner emails that are easier to
2018-12-14 14:43:03 +00:00
read, even if the reader jumps in the middle of a thread.
For example, if I emailed you:
Hey Casey,
Can you look into the bug which is causing 2.34 clients to disconnect
immediately? I think this is related to the timeouts change last week.
Also, your fix to the queueing bug is confirmed for the next release,
thanks!
You might respond with:
Hey Drew, I can look into that for sure.
> I think this is related to the timeouts change last week.
I'm not so sure. I think reducing the timeouts would *improve* this issue,
if anything.
> Also, your fix to the queueing bug is confirmed for the next release,
> thanks!
Sweet! Happy to help.
- A: Because it reverses the logical flow of conversation.
- Q: Why is top posting frowned upon?
## wrap lines
2018-12-14 14:43:03 +00:00
please wrap lines in your email at 72 columns. many people use email readers
2018-12-14 14:43:03 +00:00
designed to faithfully display plain text and won't break lines at a width which
is comfortable for reading, or won't break lines at all, which is useful when
2022-09-29 18:53:09 +00:00
reviewing patches. some readers also have many things open in addition to their
2018-12-14 14:43:03 +00:00
mail client, and may not allocate as much screen real-estate to email as you do.
if you're curious about why this arbitrary column count. "regular" terminals
2018-12-14 14:43:03 +00:00
have 80 columns, and 8 characters less gives you some room for the response
prefix ('> ') making threads with nested replies more readable.
don't worry about re-wrapping lines written by anyone you're quoting unless you
2018-12-14 14:43:03 +00:00
want to.
## pgp signatures
2018-12-14 14:43:03 +00:00
if you use pgp, please attach your signature to the message instead of using an
inline signature. look in your local pgp implementation's documentation for
2018-12-14 14:43:03 +00:00
`PGP/MIME` options.
## attachments
2018-12-14 14:43:03 +00:00
try not to send attachment to the list or, if you do it, make sure they are
small files. think about people with bad internet connection or limited
2022-09-29 18:53:09 +00:00
resources. it's better to send a link to download whatever you want to share.
if you send links, it's a good practice to describe the content and the size,
so the reader can choose to download it or not before following the link. for
example, you can upload a file to [ttm.sh](https://ttm.sh) or drop it in your
`~/public_html` directory and then send the link to the list like so:
2018-12-14 14:43:03 +00:00
2018-12-14 15:06:18 +00:00
https://ttm.sh/mydocument.pdf (pdf, 3,5MB)
2018-12-14 14:43:03 +00:00
# conclusion
2018-12-14 14:43:03 +00:00
whatever you send to a mailing list gets forwarded to an unknown number of email
accounts. you cannot know beforehand the quality of connection, resources,
2018-12-14 14:43:03 +00:00
operating systems or really anything else the people that owns those accounts
have. so, try to stick to the principles here stated to make the whole list
2018-12-14 14:43:03 +00:00
communication easier for all.
thank you for taking the time to adjust your habits!