diff options
author | Drew DeVault <sir@cmpwn.com> | 2018-07-26 16:07:34 -0400 |
---|---|---|
committer | Drew DeVault <sir@cmpwn.com> | 2018-07-26 16:10:14 -0400 |
commit | 571ee1e429b805446c0c04e449fbb4f236eadac0 (patch) | |
tree | 336918e87a1397f6c218c6e0c8d8bf97600ffd7c /lists.sr.ht/etiquette.md | |
parent | ba8bb1abb6726452466cc274adfdfd24f050dbb3 (diff) | |
download | sr.ht-docs-571ee1e429b805446c0c04e449fbb4f236eadac0.tar.gz |
Add etiquette guide
Diffstat (limited to 'lists.sr.ht/etiquette.md')
-rw-r--r-- | lists.sr.ht/etiquette.md | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/lists.sr.ht/etiquette.md b/lists.sr.ht/etiquette.md new file mode 100644 index 0000000..7c1957a --- /dev/null +++ b/lists.sr.ht/etiquette.md @@ -0,0 +1,66 @@ +Some email clients have popularized email usage patterns which are considered +poor form on many mailing lists, including sr.ht. Please review some of our +suggestions for participating more smoothly in discussions on the platform. +This advice will likely serve you well outside of sr.ht as well. Thank you for +taking the time to adjust your habits! + +# 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 development-oriented email +conversations, 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. HTML emails are rejected by all sr.ht services. + +# 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 sr.ht. 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. 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 + +Please wrap lines in your email (at least lines you wrote, don't sweat quoted +sections) at 72 columns. Many people use email readers designed to faithfully +display plaintext 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. + +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. |