Skip to content
This repository was archived by the owner on Sep 12, 2023. It is now read-only.

Latest commit

 

History

History
77 lines (58 loc) · 5.24 KB

File metadata and controls

77 lines (58 loc) · 5.24 KB

Внеси свой вклад в развитие проекта

Проект развивается на добровольной основе и в свободное время. Ты можешь поддержать его, следуя правилам, описанным ниже.

Зачем заводить ишью

  • Чтобы задать вопрос относительно проекта;
  • Чтобы сообщить о баге;
  • Чтобы обсудить идею пулл-реквеста;
  • Чтобы избежать повторов и траты твоего времени, когда хочешь отправить пулл-реквест.

Как заводить ишью

Поиск

Прежде чем что-либо написать, следует сначала поискать в ишью, пулл-реквестах и ридми интересующий вопрос. Возможно, это уже обсуждалось. Если ты уверен, что твой вопрос раньше не встречался, то смело заводи ишью.

Вопрос

  • Создай вопрос в ишью;
  • Кратко опиши суть вопроса;
  • Вопрос должен касаться только этого проекта. Не стоит злоупотреблять ишью ради своей выгоды. Вопросы по вёрстке, программированию, какому-либо инструменту, библиотеке, фреймворку, плагину и т.п. не рассматриваются - обращайся с ними в stackoverflow.com, toster.ru или воспользуйся поисковиками Google и Яндексом;
  • Если вопрос решён, оставь об этом коммент и закрой ишью.

Репорт бага

  • Если ты заметил баг, сообщи об этом в ишью;
  • Кратко опиши, с чем он связан;
  • Приложи лог или код с проблемой, предварительно оформив его в маркдауне;
  • Ссылки на строки кода;
  • Скрин при необходимости и только с конкретной областью, не нужно скринить весь рабочий стол;
  • Если ты хочешь пофиксить или уже пофиксил этот баг, предложи пулл-реквест.

Обсуждение идеи пулл-реквеста

  • Создай ишью;
  • Кратко опиши, что ты хочешь предложить;
  • Приложи код, предварительно оформив его в маркдауне;
  • Ссылки на строки кода;
  • Скрин при необходимости и только с конкретной областью, не нужно скринить весь рабочий стол;
  • Если ты хочешь сделать пулл-реквест, напиши об этом;
  • Если уже есть реализация в форке этого репозитория, предложи аппрувнуть пулл-реквест.

Как заводить пулл-реквесты

  • В комментарии укажи ссылку на обсуждение этого пулл-реквеста, чтобы не дублировать;
  • Чтобы коммиты были понятными и в едином стиле, следует придерживаться соглашения по именованию коммитов;
  • Соблюдай код-стайл от ESLint (TODO: добавить ишью для добавления проверки код-стайла тасков).

Помогай с ответами на вопросы

Знаешь ответ вопрос? Отвечая на него, ты сэкономишь нам время и тем самым внесёшь свой вклад. Не секрет, что вокруг этого проекта уже образовалось своё микросообщество, за что мы им благодарны :)

Как ещё можно помочь проекту