< ~wiki

mailing lists netiquette

the tildeverse has now its own mailing list service. you can take a look at: lists.tildeverse.org

this is a description of the basic netiquette rules for this service. most of the text is taken shamelessly from man.sr.ht/lists.sr.ht/etiquette.md 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 participating more smoothly in discussions on the tildeverse. this advice will likely serve you well outside of the tildeverse as well.

if you have any troubles following this guides or don't know how to configure your email client for this purpose, ask on irc (#meta or #team), you'll find always somebody willing to help.

plain text

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, 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 specific client.

top-posting

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 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 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 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.

wrap lines

please wrap lines in your email at 72 columns. many people use email readers 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 reviewing patches. some readers also have many things open in addition to their 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 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 want to.

pgp signatures

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 PGP/MIME options.

attachments

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 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 or drop it in your ~/public_html directory and then send the link to the list like so:

https://ttm.sh/mydocument.pdf (pdf, 3,5MB)

conclusion

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, 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 communication easier for all.

thank you for taking the time to adjust your habits!


source