Skip to content

Latest commit

 

History

History
106 lines (70 loc) · 6.8 KB

CONTRIBUTING.md

File metadata and controls

106 lines (70 loc) · 6.8 KB

Коллективное участие в проекте

постоянно наполняемый FAQ для "контрибьюторов"

Прежде чем создавать задачи GitHub

  • старайтесь ознакомиться с документацией по проекту с помощью поиска
  • старайтесь ознакомиться с уже имеющимися задачами с помощью поиска, включая закрытые задачи
  • ознакомьтесь с каталогом features для понимания уже существующего и стабильного функционала
  • будьте в курсе изменений по проекту
    • нажмите watch и star чтобы получать оповещения об изменениях

Старайтесь создавать задачи в формате BDD

  • если вы нашли "недочёт" (bug)
Дано <имею версию проекта>
  И <версию операционной системы>
  И <версию 1С предприятия>
  И <параметры совместимости конфигурации>
  • если хочется добавить новый функционал (enhancement)
Функционал: <Краткое описание>
Как <роль кому нужен функционал>
Чтобы <цель того кому нужен данный функционал>

Как добавить функционал к проекту

мы используем Example mapping, поэтому:

  • всё, что не имеет feature файла - это просто вопрос или "вброс"
  • если существует feature файл только с заголовком - это предварительное требование
  • если в feature файле есть Сценарии - это требование с правилами реализации
  • есть в Сценарии есть шаги - это требование с правилами и примерами

В связи с чем помимо задач, можно использовать концепцию

  • git-flow - коллективная разработка с помощью github
  • pull-request - для черновиков функционала используется каталог .\features\Drafts

Процесс коллективной разработки

в соответствии с принципами Agile и Open Source мы используем

  • итеративный подход к разработке
  • первоначально мы решаем недочёты, а уже затем дорабатываем функционал
  • приоретизация и порядок доработки остаются на усмотрение команды SilverBulleters, LLC

однако это можно изменить 3-мя способами:

Pull-request

если вы разработчик

  • сделайте fork репозитория
  • добавьте feature-файл
  • разработайте step проверки
  • реализуйте функционал или возьмите в работу какую-то задачу
    • обратите внимание - некоторые задачи могут иметь награду DONATIONS.md
  • сделайте pull-request

Участие в архитектурных обсуждениях

если вы методолог или архитектор

Спонсорство по задаче

если вы бизнесмен или менеджер

  • выдайте награду за любую из задач - нажав кнопку "Post a bounty on it"
  • ждите когда кто-нибудь из контрибьюторов выполнить задачу через pull-request
  • после проверки качества Ваша награда будет передана автоматически с помощью сервиса https://www.bountysource.com/teams/silverbulleters/issues контрибьютору

BSD v3 License

Наша лицензия поощряет коллективное участие в разработке всего стэка продуктов Vanessa Stack, однако не поощряет использование брендов (с) SilverBulleters, vanessa-stack, vanessa-behavior и остальных для развития своих неофициальных имплементаций. Поэтому:

  • используйте, дорабатывайте через концепцию fork и pull-request официальный продукт silverbulleters/vanessa-behavior
  • если вы хотите создать свой продукт на основе vanessa-behavior, это разрешено и не противоречит лицензии BSD v3
  • однако, если вы хотите использовать для рекламирования и продвижения своего продукта бренды "SilverBulleters" или "Vanessa Behavior", вам необходимо получить у нас разрешение на это, написав на адрес [email protected] или создать Issue на GitHub

Поэтому интернет-маркетологов просим быть осторожней при использовании символики Vanessa и SilverBulleters

CLA - лицензия на коллективное участие

Мы придерживаемся https://cla.github.com/agreement что означает Ваш вклад не нарушает никаких наших прав и не накладывает на нас никаких ограничений и обязательств.

Если ничего не понятно

  • используйте чат Gitter для того чтобы задать вопрос https://gitter.im/silverbulleters
  • запишитесь на практические занятия по правильной разработке 1С

(c) SilverBulleter, LLC - последнее обновление: 21.01.2016