Ruby

Правила публикации в списке рассылки Ruby-Talk

Вы должны следовать этим правилам при публикации в списке рассылки ruby-talk.

  1. Всегда будьте дружелюбны, внимательны, тактичны и вежливы. Мы хотим, чтобы этот список оставался гостеприимным для растущего числа новичков, совсем юных участников и их учителей, а также отвечал потребностям огнедышащих магов. :-)

  2. Следите за тем, чтобы ваш контент был релевантным и легко читаемым. Старайтесь излагать свои мысли кратко и по существу, но при этом включайте всю необходимую информацию.

    1. Общие правила форматирования (так называемый Нетикет) — это вопросы здравого смысла и элементарной вежливости, которые облегчают жизнь третьим лицам при чтении (в реальном времени или при изучении архивов):

      • Обратите внимание: Вставляйте цитируемый текст из предыдущих сообщений перед вашими ответами и цитируйте выборочно, только то, что имеет отношение к делу.
      • Используйте обычный текст (plain text); не используйте HTML, RTF или Word. В большинстве почтовых программ есть такая опция; если в вашей её нет, скачайте (бесплатную) программу или воспользуйтесь веб-сервисом, где она есть.
      • Включайте примеры из файлов как встроенный (in-line) текст; не используйте вложения.

    2. Если сообщаете о проблеме, предоставляйте всю релевантную информацию сразу; это не новостная группа экстрасенсов. :-)

      Если уместно, укажите:

      • пример (желательно простой), который воспроизводит проблему
      • фактические сообщения об ошибках
      • версию Ruby (ruby -v)
      • тип и версию ОС (uname -a)
      • название и версию компилятора, использованного для сборки Ruby

  3. Сделайте тему письма максимально информативной, чтобы люди, которым это должно быть интересно, прочитали ваш пост, а те, кому это не интересно, могли легко его пропустить.

    Полезно опишите содержимое вашего поста.

    Так правильно:

    • “How can I do x with y on z?”
    • “Problem: did x, expected y, got z.”
    • “BUG: doing x with module y crashed z.”

    Так не правильно:

    • “Please help!!!”
    • “Newbie question”
    • “Need Ruby guru to tell me what’s wrong”

    Эти префиксы стали общепринятыми для тем сообщений:

    • [ANN] (для анонсов)
    • [BUG] (для отчетов об ошибках)
    • [OT] (для оффтопа, если вам необходимо написать не по теме)

  4. Наконец, будьте внимательны: не ленитесь. Если вы ищете информацию, сначала приложите разумные усилия, чтобы найти её самостоятельно. По мере необходимости проверяйте домашнюю страницу Ruby, Ruby FAQ и другую документацию, используйте поисковик для поиска прошлых публикаций и так далее.

Эти правила были заимствованы из comp.lang.ruby FAQ.