[ARCHIVED] Правила общения

[azinit]

• Добавить, адаптировать и перевести некоторые правила Github

Правила введены для упрощения коммуникации участников организации и внешних контрибьюторов.

Термины и значения

• Дискуссия — новая тема в разделе Discussions

  • должна принадлежать какой-то категории в соответствии с её описанием
  • рекомендуется заводить по одной дискуссии на каждую тему, которую необходимо обсудить
  • для вопросов есть отдельная категория "Q&A"

• Комментарий — верхнеуровневый ответ в дискуссии.

  • каждый комментарий должен предлагать одно конкретное решение вопроса дискуссии
  • не стоит перегружать комментарий richtext-разметкой
  • самое важное стоит сформулировать в одном-двух предложениях в самом начале комментария

• Ответ — низкоуровневый ответ на комментарий.

  • не стоит оставлять пустые ответы вроде "+" или "согласен", они будут удалены
  • текст комментария должен стремиться быть коротким без пространных рассуждений
  • если комментарий всё же превратился в монорассуждение, стоит подвести итоги и коротко их обозначить
  • для выражения эмоций без текста у Github есть реакции в виде emoji

Рекомендации по оформлению соообщений

1. Длинные куски спецификаций стоит убирать под спойлер.
2. Если хочется показать разницу между формулировками, можно воспользоваться подсветкой синтаксиса diff или создать gist с предложением, изменить его и приложить ссылку на конкретную ревизию.
3. Любые портированные обсуждения из чатов лучше копировать как текст и отмечать авторов через @

[azinit]

@sergeysova

Дискуссия это одна большая тема или вопрос

Каждый ответ это один из возможных вариантов решения вопроса.
Не стоит создавать ответы в стиле “надо дописать” или “тут непонятно что нужно ещё”, лучше всё это писать сразу в описание дискуссии.

Каждый реплай на ответ должен быть коротким но емким.
Не стоит перегружать разметкой, вроде множества заголовков внутри цитат.
Всякие штуки, вроде кусков спецификаций, лучше убирать под спойлер.
Всякие сомнения и переживания и ещё что-то также убирать под спойлер с пометкой что там.

[azinit]

@sergeysova
имхо
вот такое тоже лучше не писать совсем, это подразумевается.

Лучше сразу описать, почему твое мнение не совпадает, то есть вписать аргументы

[azinit]

На самом деле я добавил этот блок попозже, т.к. заметил что многие в реплаях оч сильно триггерятся на эти заявления, и потому хотелось бы дополнительно указать - что они не мои, но их стоит обсудить

[azinit]

Также я там дальше в посте привел свое видение этих тезисов, и почему их стоит рассмотреть

[azinit]

Поэтому не знаю даж - я обычно наоборот за то, чтобы указать главную цель холивара/топика в начале, чтобы она точно не размылась в конце

[azinit]

@sergeysova
аналогично.
Это же дискуссия)

[azinit]

Ну как по мне - это добавляет человечности какой-то + авторской позиции по вопросу

Т.е. могут быть разные вариации:

• "Набрасывайте свои камни в огород"
• "Интересно послушать разные мнения"
• "Да начнется срач)"
  И т.д.

[azinit]

Как бы могу и без этого конечно постараться, но как по мне "слишком обезлично" выходит