Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 3.05 KB

CONTRIBUTION.md

File metadata and controls

28 lines (21 loc) · 3.05 KB

#Руководство по доработке проекта oscript-library

Репозиторий oscript-library включает в себя так называемую "стандартную библиотеку" пакетов OneScript, которые поставляются вместе с самим интерпретатором OneScript. В связи с этим, есть два варианта добавления вашего кода в проект:

  • Вы хотите доработать существующий пакет
  • Вы хотите добавить свой пакет в стандартную библиотеку

##Я хочу доработать существующий пакет

  • Создайте issue в oscript-library с описанием того, что вы хотите доработать. Это нужно для того, чтобы исключить двойную работу. Возможно, кто-то начнет делать нечто похожее одновременно с вами. Issue позволит видеть ведущуюся или планирующуюся работу.
  • Создайте форк oscript-library в своем аккаунте github
  • Создайте ветку в своем форке с названием feature/issue-<номер issue>-<любой текст на ваш выбор, если надо>
  • Внесите необходимые доработки в своем форке
  • Создайте pull-request нажатием на соответствующую кнопку в гитхабе и отправьте его нам
  • Команда разработки посмотрит код и, вероятно, внесет дополнения и предложения.
  • Внесите в ваш код эти дополнения таким же образом - просто дополнительными коммитами в ту же ветку feature/*
  • Новый pull-request создавать не надо, дополнения будут видны сразу.
  • Когда код будет принят командой, ваши изменения попадут в основную ветку, а ваше имя - в список контрибьюторов oscript-library
  • Спасибо!

##Я хочу добавить свой пакет в стандартную библиотеку

  • Создайте репозитарий на github, поместите в него свою библиотеку
  • Создайте issue в oscript-library с предложением к сообществу о включении вашего пакета в стандартную библиотеку
  • Мы посмотрим ваш код и если он нам нужен именно в стандартной библиотеке - мы скажем спасибо и с удовольствием его возьмем

Пакет должен иметь в своем составе файл packagedef с описанием пакета.