Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (38 loc) · 4.27 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 4.27 KB
Raw

Помочь в разработке легко

Настройка окружения

Платформа 1С:Предприятие

Для разработки используется платформа версии 8.3.24.1548

Дополнительные инструменты

Для корректной разработки потребуются дополнительные инструменты:

  • Oscript. Используемая версия движка stable
    • Инструкция по установке(TODO: добавить ссылку)
  • Vrunner. Используемая версия 2.6.0
  • Precommit4onec
  • Расширение YAXUNIT

Последовательность действий при инициализации

  1. Склонируйте репозиторий git clone
  2. Установите Onescript
  3. Установите необходимые пакеты(opm install vrunner precommit4onec)
  4. Установите precommit-hook выполнив precommit4onec install <Путь к репозиторию> заменив <путь к репозиторию> на ваш.
  5. Скопируйте файл [env.json.example](env.json.example) и переименуйте его в env.json
  6. При необходимости внесите изменения в файл env.json (cm vrunner help)
  7. Запустите подготовленный скрипт prepare.cmd

Первоначальная настройка YAXUNIT

  1. Откройте конфигуратор
  2. Откройте параметры запуска (Сервис-Параметры-Запуск 1С: Предприятия)
  3. Установите в параметр запуска следующую строку RunUnitTests=<Путь к репозиторию>\tests\uaxunit_config.json заменив <путь к репозиторию> на ваш.
  4. Теперь при запуске 1с пердприятия будут выполняться тесты и открываться форма с результатами.

Поздравляю, вы молодец и готовы приступать к разработке.

Автоматическая настройка окружения

Для автоматической настройки окружения реализован init-project.cmd после первого клонирования репозитория вы можете запустить этот файл и он автоматически сконфигурирует ваш проект, скачает нужные пакеты и подготовит базу для разработки.

Пока этот функционал в разработке и может работать не стабильно. Буду благодарен за обратную связь.

Процесс разработки

Мы используем git-flow. и наш процесс разработки выглядит примерно так:

  1. Перед стартом разработки, первым делом создаем ветку отводя ее от актуальной версии ветки develop и переключаемся на нее. git checkout -b <ИмяВашейВетки> develop
  2. Запускаем update.cmd и обновляем свою БД конфигурацией из требуемой ветки. (!ВНИМАНИЕ! ЭТО ОБЯЗАТЕЛЬНЫЙ ПУНКТ. ИНАЧЕ МОГУТ ВОЗНИКНУТЬ ПРОБЛЕМЫ С ФАНТОМНЫМИ ИЗМЕНЕНИЯМИ!)
  3. Продумываем функционал, и подготавливаем тесты, которые будут тестировать результат нашей разработки.
  4. Реализуем задуманый функционал
  5. Проверяем, что "тесты зеленые". Это значит, что мы не сломали ничего из уже написанного.
  6. Запускаем deсompile.bat
  7. Описываем сделанные изменения в сообщении коммита и фиксируем их.
  8. Создаем MR из вашей ветки в ветку develop