CONTRIBUTING.md

Contributing to FOMpy

Следуйте правилам и инструкциям, описанным в этом файле, если вы хотите внести свой вклад в развитие FOMpy.

Правила репозитория

• Держать все величины и расчёты в СГС (Гауссовой системе единиц). В промежуточных вычислениях применение внесистемных единиц не приветствуется.
• Приводить все величины физических констант с точностью до 4 значащих цифр. Меньшая точность допускается, если значение неизвестно с достаточной точностью.
• Не использовать транслитерацию названий с русского на английский (например, вместо Poluprovodnik используйте Semiconductor).
• Приветствуется документация к каждой функции (какую величину вычисляет, какие принимает), можно на русском.
• Желательно подписывать каждый коммит, используя опцию -S.

Установка

Если вы имеете доступ на запись в этот репозиторий, вы можете работать с ним напрямую, предварительно сообщив о вносимых изменениях. Если вы не имеете доступа (или не хотите со мной говорить), вы можете создать fork, внести изменения в свою копию репозитория и сделать pull request.

• Сначала клонируйте репозиторий, используя команду

  $ git clone https://github.com/kononovarseniy/fompy.git
  

• Перейдите в директорию проекта:

  $ cd fompy
  

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

  $ python -m venv .venv
  $ source .venv/bin/activate
  $ pip install --upgrade pip
  $ pip install -e .
  

• Теперь можно открыть проект в вашей любимой IDE и внести необходимые изменения.

Генерация документации

Чтобы перегенерировать файлы документации, необходим пакет pdoc3:

$ pip install pdoc3

Генерация файлов документации осуществляется командой

$ pdoc --force --html --template-dir=docs/templates -o docs fompy

Запуск тестов и проверка покрытия

coverage run --source=fompy tests.py && coverage report -m