альфа версия правил.

Author: thedemoncat

.github/CONTRIBUTING.md

@@ -0,0 +1,173 @@
+# Коллективное участие в проекте
+
+> постоянно наполняемый FAQ для "контрибьюторов"
+
+## Прежде чем создавать задачи (issues) `GitHub`
+
+* старайтесь ознакомиться с документацией по проекту с помощью поиска
+* старайтесь ознакомиться с уже имеющимися задачами с помощью поиска, включая закрытые задачи
+* ознакомьтесь с каталогом features для понимания уже существующего и стабильного функционала
+* будьте в курсе изменений по проекту
+  * нажмите `watch` и `star`, чтобы получать оповещения об изменениях
+
+### Старайтесь создавать задачи в формате `BDD`
+
+* Формат описания, если вы нашли "недочёт" (bug)
+
+```gherkin
+Дано <имею версию проекта>
+  И <версию операционной системы>
+  И <версию 1С предприятия>
+  И <параметры совместимости конфигурации>
+```
+
+* Формат описания, если хочется добавить новый функционал (enhancement)
+
+```gherkin
+Функционал: <Краткое описание>
+Как <роль кому нужен функционал>
+Чтобы <цель того кому нужен данный функционал>
+```
+
+## Как добавить функционал к проекту
+
+мы используем [Example mapping](https://cucumber.io/blog/2015/12/08/example-mapping-introduction), поэтому:
+
+* всё, что не имеет feature-файла - это просто вопрос или "вброс"
+* если существует feature-файл только с заголовком - это предварительное требование
+* если в feature-файле есть Сценарии - это требование с правилами реализации
+* есть в Сценарии есть шаги - это требование с правилами и примерами
+
+Соответственно, помимо задач, можно использовать концепцию
+
+* git-flow - коллективная разработка с помощью github
+* pull-request - для черновиков функционала используется каталог ```.\features\Drafts```
+
+### Процесс коллективной разработки
+
+в соответствии с принципами Agile и Open Source мы используем
+
+* итеративный подход к разработке
+* первоначально мы решаем недочёты, а уже затем дорабатываем функционал
+* приоретизация и порядок доработки остаются на усмотрение команды SilverBulleters, LLC
+
+однако это можно изменить 3-мя способами:
+
+### Pull-request
+
+#### Первичная настройка
+
+если вы разработчик
+
+* Установите `oscript`, `git` и проверьте, что данные находятся в переменной `PATH`,
+  * т.е. `git, oscript, opm` вызываются без указания полного пути в коммандной строке.
+
+* сделайте `fork` репозитория
+* склонируйте репозитарий себе на машину ```git clone https://github.com/*ТУТИМЯВАШЕГОПОЛЬЗОВАТЕЛЯ*/gitsync.git ```
+* переходим в склонированный каталог через `cd add` и выполняем несколько магических комманд
+```
+git remote add upstream https://github.com/oscript-library/gitsync.git
+git fetch upstream
+git checkout -b develop upstream/develop
+git pull upstream develop
+```
+* Далее нужно установить необходимые зависимости:
+  * в консоли от имени администратора перейти в папку `gitsync` и запустить `opm install`.
+  * Результатом будет установленные пакеты, необходимые для работы скриптов.
+  * Этот шаг необходимо сделать всего 1 раз.
+
+> ВНИМАНИЕ: команды `opm` необходимо выполнять в обычном виндовом `cmd\far` , но не в bash-консоли, т.к. не сможет найти команду `opm`
+
+#### Штатная разработка/доработка
+
+##### Выбор задачи и предварительная подготовка
+
+* реализуйте функционал или возьмите в работу какую-то задачу
+  * обратите внимание - некоторые задачи могут иметь награду [DONATIONS.md](/DONATIONS.md)
+
+* На основании ветки develop создаем новую ветку с номером задачи или кратким описанием
+  * Например, `feature/issue-9999`
+```
+git checkout -b feature/issue-9999
+```
+
+> Напоминаем, что все шаги git можно выполнять как из консоли git, так и из графического клиента для git (SourceTree, GitExtensions и т.п.)
+
+##### Изменения в плагинах/фичах/шагах/тестах
+
+* в каталоге `add\features` добавьте новый `feature-файл`, если необходимо
+* в каталоге ./src реализуйте требуемый функционал
+* или прогоните тесты `opm run test`
+
+* **При готовности зафиксировать изменения** 
+
+* В гите проверить необходимые изменения в исходниках и зафиксировать только их.
+
+Команды для программного добавления необходимых файлов в git
+
+    * Смотрим, какие файлы изменились - `git status`
+
+```
+      Изменения, которые не в индексе для коммита:
+        (используйте «git add <файл>…», чтобы добавить файл в индекс)
+        (используйте «git checkout -- <файл>…», чтобы отменить изменения
+        в рабочем каталоге)
+
+        изменено:      src/cmd/ПараметрыПриложения.os
+
+      нет изменений добавленных для коммита
+      (используйте «git add» и/или «git commit -a»)
+```
+
+##### Отправка изменений
+
+  * Добавляем необходимые файлы в индекс
+    * `git add src/cmd/ПараметрыПриложения.os `
+  * Фиксируем изменения с комментарием `git commit -m "Наш комментарий!"`
+
+* Отправляем все изменения своей ветки на github ```git push origin feature/issue-9999```
+* Далее формируем `pull-request` в [интерфейсе github](https://github.com/oscript-library/gitsync/pulls)
+
+### Участие в архитектурных обсуждениях
+
+если вы методолог или архитектор
+
+* сделайте свой первый `pull-request`, в том числе в документацию
+* создайте обсуждение https://github.com/oscript-library/gitsync/issues с описанием противоречия
+* участвуйте, обосновывайте, приводите примеры
+* используйте ТРИЗ для построения непротиворечивых решений
+
+### Enterprise-поддержка
+
+если вы бизнесмен или менеджер
+
+* обратитесь по адресу `[email protected]`
+* заключите контракт на Enterprise-поддержку с гарантией по SLA и c контролем NPS
+* публикуйте любые запросы на доработку и консультацию - они будут выполнены или по ним будет выдан ответ в первом приоритете
+  * на данный момент за последние год мы поддерживаем следующие медианы:
+    * время реакции - 24 минуты,
+    * время решения - 23 часа
+
+# BSD v3 License
+
+Наша лицензия поощряет коллективное участие в разработке всего стэка продуктов `Vanessa Stack`, однако не поощряет использование брендов (с) `SilverBulleters`, `vanessa-stack`, `vanessa-gitsync`,  и остальных для развития своих неофициальных имплементаций.
+
+Поэтому:
+
+* используйте, дорабатывайте через концепцию `fork` и `pull-request` официальный продукт `oscript-library/gitsync`
+* если вы хотите создать свой продукт на основе `oscript-library/gitsync`, это разрешено и не противоречит лицензии `BSD v3`
+* однако, если вы хотите использовать для рекламирования и продвижения своего продукта бренды ``"SilverBulleters"``, ``"Vanessa Gitsync"`` или ``"Vanessa"``, вам необходимо получить у нас разрешение на это, написав на адрес `[email protected]` или создать `Issue` на `GitHub`
+
+Поэтому интернет-маркетологов просим быть осторожней при использовании символики `Vanessa` и `SilverBulleters`
+
+# CLA - лицензия на коллективное участие
+
+Мы придерживаемся https://cla.github.com/agreement
+что означает - Ваш вклад не нарушает никаких наших прав и не накладывает на нас никаких ограничений и обязательств.
+
+# Если ничего не понятно
+
+* используйте [форум XDD](https://xdd.silverbulleters.org) для того, чтобы задать вопрос
+* запишитесь на практические занятия по правильной разработке 1С
+
+```(c) SilverBulleter, LLC - последнее обновление: 14.01.2019```