Skip to content

Latest commit

 

History

History
93 lines (56 loc) · 6.11 KB

CONTRIBUTING.md

File metadata and controls

93 lines (56 loc) · 6.11 KB

Руководство осеннего контрибьютера

Введение

Здравствуй, если ты здесь, значит осень захватила тебя, и ты решил превратить нашу еще пока сырую осень, в замечательную золотую осень. Впереди долгий путь, и тебе нужно быть сильным и смлым. А это руководство поможет тебе.

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

  • Необходимо установить oscript и ovm - последних версий. Осень - инновационный продукт, и использует все новые возможности языка. Потому для корректной работы, необходима последнияя версия oscript.

  • Установи Git

  • Желательно, но не обязательно поставить Visual studio code c расширениями 1C (BSL) Extension Pack.

Перед тем как приступить

  • Сделай форк этого репозитория себе.

  • Склонируй свою версию репозитория к себе в рабочее окружение.

git clone <http://github.com/ссылкаНаТвойРепозиторий>
  • Перейди в созданную папку и создай ветку в которой ты будешь делать свои доработки
git checkout -b <ИмяТвоейВетки>

Инициализация зависимостей

  • Для корректной работы и проверки необходимо инициализировать зависимости.
Opm install -l --dev

Для целей разработки используются версии пакетов которые установятся в папку oscript_modules

  • Можете проверить что все равботает запустив тесты
Oscript tasks/test.os

Если все прошло гладко, вы получите мини отчет, что то в этом духе

РезультатПрогонаТестов

Настройка отладки

Как известно, нормальному программисту отладка не нужна, отлаживай через вызватьИсключение.

Но если ты все таки слаб духом, то:

  1. Открывай вкладку "Запуск и отладка"(Плагин для отладки мы установили ранее вместе с 1C (BSL) Extension Pack)

  2. Проверяй, что в файле launch.json актуальные настройки

  3. Открывай файл, который ты хочешь запустить с отладкой(например test.os)

  4. Нажимай кнопку "Начать отладку" Пример отладки

Начни с тестов

Если ты делаешь новый функционал, то его надо будет как-то проверить, а заодно, было бы здорово, чтобы любой другой мог проверить потом, что не разломал твой код после очередного обновления.

На данный момент существует несколько основных наборов тестов наборов тестов.

Выбери куда должны быть добавлены твои тесты и опиши их примерно так: ПримерОписанияТеста

Разработка

Если ты дошел до этого пункта - вряд-ли тебе нужны какие-то советы по разработке. Просто делай нормально

Перед тем как завершить

  1. Прогони тесты, падающих быть не дожно. Если ты меняешь функционал так, что тесты и не должны работать - откорректируй их. В этом случае обязательно оставь в ПР комментарий, почему тесты которые ты правишь - больше не актуальны.
  2. Если ты добавил новую фичу - опиши ее в документации. Неописаная фича - работа в стол, вероятность что ей будут активно пользоваться очень мала.
  3. перед отправкой изменений - обязательно проверь, что ничего лишнего не попало в репозиторий. В удаленном репозитории не должно быть папки oscript_modules и out, не должно быть никаких лишних, не относящихся к твоей фиче файлов

Создай Pull-request

Все, новая фича готова чтобы показать ее миру! Самое время создать ПР и поделиться ей с сообществом.