From 80e1f4e25c8965f7c37147e8413bc0950b1654e9 Mon Sep 17 00:00:00 2001 From: "Sergey S. Betke" Date: Sun, 5 Nov 2017 12:15:44 +0300 Subject: [PATCH] =?UTF-8?q?*=20=D0=B4=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=20.github?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/CONTRIBUTING.md | 44 ++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 22 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 13 ++++++++++ 3 files changed, 79 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..7815d4eb --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,44 @@ +# Коллективное участие в проекте + +## Прежде чем создавать задачи `GitHub` + +* старайтесь ознакомиться с документацией по проекту в + [readme.md](https://github.com/Metrolog/marks/blob/master/readme.md) +* старайтесь ознакомиться с уже имеющимися задачами с помощью поиска, + включая закрытые задачи +* будьте в курсе изменений по проекту + * нажмите watch и star чтобы получать оповещения об изменениях + +## Как добавить функционал к проекту + +Помимо задач, можно использовать концепцию +[GitHub-flow](https://guides.github.com/introduction/flow/). + +### Процесс коллективной разработки + +Мы используем + +* итеративный подход к разработке +* первоначально мы решаем недочёты, а уже затем дорабатываем функционал +* приоритет и порядок доработки остаются на наше усмотрение + +однако это можно изменить: + +### Pull-request + +Если вы разработчик + +* сделайте `fork` репозитория +* реализуйте функционал или возьмите в работу какую-то задачу +* сделайте `pull-request` + +# CLA - лицензия на коллективное участие + +Мы придерживаемся https://cla.github.com/agreement, +что означает Ваш вклад не нарушает никаких наших прав +и не накладывает на нас никаких ограничений и обязательств. + +# Если ничего не понятно + +* используйте чат Gitter для того чтобы задать вопрос +https://gitter.im/Metrolog/marks diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..10873b0d --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,22 @@ +Требования к оформлению вопроса: +-------------------------------- + +* данный раздел (Требования к оформлению вопроса) должен быть удалён до + публикации +* заполнен должен быть только один из разделов (либо ошибки, либо пожелания) +* крайне желательно приложить изображение оттиска с указанием несоответствий + либо пожеланий + +Ошибки: +------- + +- +- +- + +Требуемый дополнительный функционал: +------------------------------------ + ++ ++ ++ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..9346aba0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +Исправлены ошибки: +------------------ + +- (по возможности - указывать ссылку на issue через `#номер-issue`) +- +- + +Дополнительные функционал: +-------------------------- + ++ ++ ++