Skip to content

Commit

Permalink
Merge remote-tracking branch 'vendor/develop' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
Asakra committed Nov 17, 2023
2 parents 60f185f + 3610dbc commit 73dbd00
Show file tree
Hide file tree
Showing 974 changed files with 75,018 additions and 11,789 deletions.
58 changes: 30 additions & 28 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
# Коллективное участие в проекте

> постоянно наполняемый FAQ для "контрибьюторов"
## Простой чек-лист использования

- если скачали в первый раз, выполните `opm run init`
- для сборки\компиляции только внешних файлов выполните `opm run cepf` - все соберется, только тестовые ИБ не будут обновлены
- для выгрузки\декомпиляции своих изменений в исходники `opm run depf`
- и стандартный процесс Гитхаба - Пулл-реквесты и т.д.

Ниже есть более подробные описания всех этих действий и возможных проблем.

* Мы используем подход git-flow для реализации функциональности
* Мы используем принцип самопроверки через feature файлы, поэтому перед разработкой новой функциональности мы также - разрабатываем feature файлы, генерируем шаблоны сценариев и наполняем их кодом для проверки. Поэтому к доработкам без feature файлов все участники относятся "холодно".
* Старайтесь создавать тесты в формате `BDD` или пишите модульные тесты.
* Наличие тестов не всегда является обязательным. При каждой новой доработке используем индивидуальный подход для облегчения входа новых контрибьюторов и ускорения появления полезной функциональности
* Мы используем принцип самопроверки через feature файлы, поэтому перед разработкой новой функциональности мы также - разрабатываем feature файлы, генерируем шаблоны сценариев и наполняем их кодом для проверки.
* Также возможно обычные модульные тесты, написанные кодом 1С.

## Прежде чем создавать задачи (issues) `GitHub`

Expand All @@ -12,7 +22,6 @@
* ознакомьтесь с каталогом features для понимания уже существующего и стабильного функционала
* будьте в курсе изменений по проекту
* нажмите `watch` и `star`, чтобы получать оповещения об изменениях
* зарегистрируйтесь на форуме XDD и подпишитесь на получение новостей из раздела [ADD](https://xdd.silverbulleters.org/c/razrabotka/xdrivendevelopment)

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

Expand Down Expand Up @@ -53,7 +62,7 @@

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

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

Expand All @@ -73,7 +82,7 @@
* склонируйте репозитарий себе на машину ```git clone https://github.com/*ТУТИМЯВАШЕГОПОЛЬЗОВАТЕЛЯ*/add.git ```
* переходим в склонированный каталог через `cd add` и выполняем несколько магических комманд
```
git remote add upstream https://github.com/silverbulleters/add.git
git remote add upstream https://github.com/vanessa-opensource/add.git
git fetch upstream
git checkout -b develop upstream/develop
git pull upstream develop
Expand Down Expand Up @@ -112,6 +121,11 @@ git checkout -b feature/issue-9999
* теперь нужно собрать бинарные файлы из исходников. Для этого запустите сборку:
```opm run cepf```

> ВНИМАНИЕ: текущая версия `opm` использует версию библиотеки `fs`, которая не поддерживает некоторые методы, использующиеся в скриптах сборки.
>Поэтому необходимо
- либо запускать задание вызовом `oscript tasks/cepf.os`,
- либо обновить локальную установку `fs` внутри `opm` (запустить `opm install -l fs` в каталоге установки `opm`).

##### Изменения в плагинах/фичах/шагах/тестах

* в каталоге `add\features` добавьте новый `feature-файл`, если необходимо
Expand All @@ -123,7 +137,11 @@ git checkout -b feature/issue-9999
* после всех доработок можете запустить в каталоге проекта `opm run vanessa` для проверки на управляемых формах, что ничего не сломали из стандартного функционала.
* или прогоните тесты `opm run xdd`

* **При готовности зафиксировать изменения** необходимо теперь сделать обратную операцию в виде разборки *.epf на исходники:
Можно воспользоваться Чек-листом создания фичи для самотестирования Vanessa-ADD.

- [Как быстро написать проверочную фичу для новой возможности, реализуемой внутри самого Vanessa.ADD или его плагина?](/F.A.Q.MD#2-как-быстро-написать-проверочную-фичу-для-новой-возможности-реализуемой-внутри-самого-vanessaadd-или-его-плагина)

**При готовности зафиксировать изменения** необходимо теперь сделать обратную операцию в виде разборки *.epf на исходники:
1. Массово выполните команду `opm run depf`
* все обработки будут разобраны на исходники
> ВНИМАНИЕ: возможно будет долгая операция, т.к. скрипт найдет все epf-файлы во всех подкаталогах и попробует их разобрать на исходники
Expand Down Expand Up @@ -174,40 +192,27 @@ git checkout -b feature/issue-9999
* Фиксируем изменения с комментарием `git commit -m "Наш комментарий!"`

* Отправляем все изменения своей ветки на github ```git push origin feature/issue-9999```
* Далее формируем `pull-request` в [интерфейсе github](https://github.com/silverbulleters/add/pulls)
* Далее формируем `pull-request` в [интерфейсе github](https://github.com/vanessa-opensource/add/pulls)


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

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

* сделайте свой первый `pull-request`, в том числе в документацию
* создайте обсуждение https://github.com/silverbulleters/add/issues с описанием противоречия
* создайте обсуждение https://github.com/vanessa-opensource/add/issues с описанием противоречия
* участвуйте, обосновывайте, приводите примеры
* используйте ТРИЗ для построения непротиворечивых решений

### Enterprise-поддержка

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

* обратитесь по адресу `[email protected]`
* заключите контракт на Enterprise-поддержку с гарантией по SLA и c контролем NPS
* публикуйте любые запросы на доработку и консультацию - они будут выполнены или по ним будет выдан ответ в первом приоритете
* на данный момент за последние год мы поддерживаем следующие медианы:
* время реакции - 24 минуты,
* время решения - 23 часа

# BSD v3 License

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

Поэтому:

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

Поэтому интернет-маркетологов просим быть осторожней при использовании символики `Vanessa` и `SilverBulleters`
* однако, если вы хотите использовать для рекламирования и продвижения своего продукта бренды ``"Vanessa ADD"`` или ``"Vanessa ADD"``, вам необходимо получить у нас разрешение на это, создав `Issue` на `GitHub`

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

Expand All @@ -216,7 +221,4 @@ git checkout -b feature/issue-9999

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

* используйте [форум XDD](https://xdd.silverbulleters.org) для того, чтобы задать вопрос
* запишитесь на практические занятия по правильной разработке 1С

```(c) SilverBulleter, LLC - последнее обновление: 20.07.2018```
* запишитесь на практические занятия по правильной разработке 1С у Артур Аюханова aka artbear.
24 changes: 18 additions & 6 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,32 @@

> Заполните шаблон обсуждения GIT (GitHub, GitLab, Vanessa Hub)
<!-- Заполните шаблон обсуждения GIT (GitHub, GitLab) -->

```Gherkin
Функционал: <Необходимый эффект>
Как <роль пользователя>
Я хочу <Необходимый функционал>
Контекст:
Дано <версия инструментария>
И <полная версия 1С>
и <конфигурация запуска>
Дано мое окружение, полученное по команде "Техническая информация" из Ванесса-АДД:
"""
Техническая информация:
- Версия Vanessa-ADD: *
- Имя конфигурации: *
- Синоним конфигурации: *
- Версия конфигурации: *
- Платформа 1С: *
- Режим совместимости (для TestManager): *
- Режим совместимости интерфейса (для TestManager): *
- Режим запуска: *
- Тип базы: *
- Язык (для TestManager): *
- Локализация (для TestManager): *
- Операционная система: *
"""
Сценарий: <ожидамое поведение>
Допустим <Пример данных>
Когда <Что-то нажимается или вызывается>
Тогда <Что-то происходит>
```

> Прикладывайте файлы скриншотов
<!-- Прикладывайте файлы скриншотов -->
39 changes: 28 additions & 11 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,50 @@
---
name: Сообщение об ошибке
about: если вы выявили ошибку - сообщите нам об этом
title: '[BUG]'
labels: bug
assignees: ''

---

**Описание ошибки**
что конкретно происходит
<!-- что конкретно происходит -->

**Сценарий воспроизведения**
Шаги по воспроизведению:
<!-- Шаги по воспроизведению:
1. Открыть '...'
2. Нажать '....'
3. Запустить '....'
4. Где ошибка
4. Где ошибка -->

**Ожидаемое поведение, если бы ошибки не было**
'....'
<!-- '....' -->

**Скриншоты**
если применимо, приложите скриншоты
<!-- если применимо, приложите скриншоты -->

**Окружение:**

- Версия операционной системы: [например, `Windows 10 (64)` или `Ubuntu 18.04`]
- Редакция платформы 1С [например, `8.3.12.1542`]
- Версия `Vanessa.ADD` [например, `5.6.0`]
- Версия `OneScript` [например, `1.0.21`]
<!---
- Описание окружения рекомендуем получить сразу из Vanessa-ADD - подменю "Загрузить" - кнопка "Техническая информация" и вставить сюда.
Пример:
Техническая информация:
- Версия Vanessa-ADD: ver 6.5.0
- Имя конфигурации: ADD_BDD
- Синоним конфигурации: ADD/BDD, ver. 6.5.0
- Версия конфигурации: 6.5.0
- Платформа 1С: 8.3.15.1778
- Режим совместимости (для TestManager): Версия8_3_8
- Режим совместимости интерфейса (для TestManager): Такси
- Режим запуска: Управляемое приложение (Тонкий клиент)
- Тип базы: Файловая ИБ
- Язык (для TestManager): Русский
- Локализация (для TestManager): ru
- Операционная система: Windows 10 (64)
-->

**Дополнительный контекст**

- Типовая или не типовая конфигурация ?
- Включен ли режим защиты от опасных действий и т.д.
<!-- - Типовая или не типовая конфигурация ?
- Включен ли режим защиты от опасных действий
- и т.д. -->
14 changes: 3 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,10 @@ about: предложение новой идеи или функциональ
---

**Существует проблема**
Описание существующей проблемы [...]
<!-- Описание существующей проблемы [...] -->

**Хотелось бы иметь следующую функциональность**
Вариант реализации [...]
<!-- Вариант реализации [...] -->

**Дополнительный контекст**
Любая дополнительная информация

<!---
Заявление от команды активных контрибьюторов
Данный проект развивается силами нескольких людей последние 10 лет, разработка ведется на условиях краудсорсинга в связи с чем
Если вы не собираетесь реализовывать данную функциональность сами, просьба идеи и предложения обсуждать на форуме в специализированном разделе https://xdd.silverbulleters.org/c/razrabotka или в рамках вашего контракта на поддержку OpenSource продуктов
-->
<!-- Любая дополнительная информация -->
Loading

0 comments on commit 73dbd00

Please sign in to comment.