|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: "Posting Guidelines for the Ruby-Talk Mailing List" |
| 4 | +lang: ru |
| 5 | +--- |
| 6 | + |
| 7 | +You should follow these guidelines when posting to the ruby-talk mailing list. |
| 8 | +{: .summary} |
| 9 | + |
| 10 | + |
| 11 | +1. **Always** be friendly, considerate, tactful, and tasteful. We want to |
| 12 | + keep this list hospitable to the growing ranks of newbies, very |
| 13 | + young people, and their teachers, as well as cater to fire breathing |
| 14 | + wizards. :-) |
| 15 | + |
| 16 | +2. Keep your content relevant and easy to follow. Try to keep your |
| 17 | + content brief and to the point, but also try to include all relevant |
| 18 | + information. |
| 19 | + |
| 20 | + 1. The general format guidelines (aka Netiquette) are |
| 21 | + matters of common sense and common courtesy that make life |
| 22 | + easier for third parties to follow along (in real time or when |
| 23 | + perusing archives): |
| 24 | + |
| 25 | + * **Please note:** |
| 26 | + Include quoted text from previous posts **before** your responses |
| 27 | + and **selectively** quote as much as is relevant. |
| 28 | + * Use **plain text**; don't use HTML, RTF, or Word. |
| 29 | + Most email programs have an option for this; if yours doesn't, |
| 30 | + get a (free) program or use a web-based service that does. |
| 31 | + * Include examples from files as **in-line** text; don't use |
| 32 | + attachments. |
| 33 | + |
| 34 | + 2. If reporting a problem, give **all** the relevant information |
| 35 | + the first time; this isn't the psychic friends newsgroup. :-) |
| 36 | + |
| 37 | + When appropriate, include: |
| 38 | + |
| 39 | + * an example (preferably simple) that produces the problem |
| 40 | + * the actual error messages |
| 41 | + * the version of Ruby (`ruby -v`) |
| 42 | + * the OS type and version (`uname -a`) |
| 43 | + * the compiler name and version used to build Ruby |
| 44 | + |
| 45 | +3. Make the subject line maximally informative, so that people who |
| 46 | + should be interested will read your post and so that people who |
| 47 | + wouldn't be interested can easily avoid it. |
| 48 | + |
| 49 | + **Usefully** describe the contents of your post. |
| 50 | + |
| 51 | + This is OK: |
| 52 | + |
| 53 | + * "How can I do x with y on z?" |
| 54 | + * "Problem: did x, expected y, got z." |
| 55 | + * "BUG: doing x with module y crashed z." |
| 56 | + |
| 57 | + This is **not** OK: |
| 58 | + |
| 59 | + * "Please help!!!" |
| 60 | + * "Newbie question" |
| 61 | + * "Need Ruby guru to tell me what's wrong" |
| 62 | + |
| 63 | + These prefixes have become common for subject lines: |
| 64 | + |
| 65 | + * `[ANN]` (for announcements) |
| 66 | + * `[BUG]` (for bug reports) |
| 67 | + * `[OT]` (for off-topic, if you must post off-topic) |
| 68 | + |
| 69 | +4. Finally, be considerate: Don't be too lazy. If you are seeking |
| 70 | + information, first make a reasonable effort to look it up. As |
| 71 | + appropriate, check the [Ruby home page][ruby-lang], |
| 72 | + check the [Ruby FAQ][faq] and other documentation, |
| 73 | + use a search engine to search past postings, and so on. |
| 74 | + |
| 75 | + |
| 76 | +_These guidelines where adopted from the [comp.lang.ruby FAQ][clrFAQ]._ |
| 77 | + |
| 78 | + |
| 79 | + |
| 80 | +[ruby-lang]: /en/ |
| 81 | +[faq]: /en/documentation/faq/ |
| 82 | +[clrFAQ]: http://rubyhacker.com/clrFAQ.html |
0 commit comments