Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 4.66 KB

contributing.md

File metadata and controls

48 lines (31 loc) · 4.66 KB

Как внести свой вклад в EasyEPLANner

Пожалуйста, следуйте правилам кодирования, которые находятся тут.

Для работы на платформе GitHub изучите эту документацию.

Если вы нашли ошибку

  • Поищите в вопросах (issues), описана ли такая проблема там. Если она описана, не стоит беспокоиться, мы работаем над её решением.
  • Если Вы не нашли описанную Вами проблему, то создайте новый вопрос (issue). Опишите найденную Вами ошибку, а так же укажите, при каких условиях Вы смогли её найти.

Хотите исправить ошибку?

  • Сделайте fork (вилку) репозитория, в котором Вы будете исправлять ошибку.
  • Исправьте ошибку.
  • Откройте новый GitHub PB (Pull Request) с исправлением.
  • Убедитесь, что в его описании четко описаны проблема и решение. Включите соответствующий номер вопроса, если это возможно.

Открытие вопроса (issue)

Это стоит делать в следующих случаях:

  • Сообщить об ошибке, которую вы не можете решить самостоятельно.
  • Обсудить тему или идею высокого уровня (например, сообщество).
  • Предложить новую функцию или другую идею проекта.

Советы по общению в issue

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

Открытие запроса на извлечение (pull request)

Это стоит делать в следующих случаях:

  • Внесение тривиальных исправлений (например, неработающая ссылка, опечатка или очевидная ошибка).
  • Начало работы над нововведениями, которые необходимы или уже обсуждались в вопросе (issue).

PB (pull request) не обязательно должен представлять законченную работу. Обычно лучше сначала открыть запрос на извлечение раньше, что бы другие могли наблюдать за Вашими успехами или высказать свое мнение. Просто создайте Draft Pull Request, что бы указать, что над PB еще ведется работа.

Документация к проекту

Алгоритм работы с дополнением описан в пользовательской документации.

Есть вопросы по исходному коду или предложения по улучшению?

Помимо issue для связи с нами можно использовать: