Участие в разработке

Добро пожаловать в Ormar!

Вопросы

Чтобы мы могли помочь вам максимально просто, пожалуйста, включите следующее:

• Операционные системы
• Версия Python.
• версия Ormar
• Сервер базы данных (MySQL, sqlite или postgresql)

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

Запрос на получение

Начинать и создавать запрос на вытяжку должно быть очень просто.

!!!Обратите внимание, что, если изменения не являются незначительными (орфографические ошибки, изменения документа и т. д.), перед созданием запроса на вытяжку создайте вопрос для обсуждения изменений.

Чтобы сделать вклад максимально простым и быстрым, вам нужно запустить тестирование и линтинг локально.

Для этого необходимо установить Python 3.6.2, 3.7 или 3.8, poetry и git.

«Clone Your Fork and CD Into the Repo Directory
git clone git@github.com:<your username>/ormar.git
CD Ormar

Установить ормар, зависимость и тест зависимости.
poetry install -E dev

Checkout a new branch and make your changes
git checkout-b my-new-feature-branch
«Сделай свои изменения...

Новые и линтинги
# ormar uses black for formatting, flake8 for lining and mypy for type hints check
Run all of the Following as All Those calls will be run on travis after every push
Black Ormar Tests
Flake8 ormar
Mypy Ormar Tests

# 5. Run tests
# on localhost all tests are run Against sglite backend
Оригинальное название: Rest of the Backends Will Be checked after push
pytest-svv---cov =ormar--cov =tests---cov-fail-under =100---cov-report =term-missing

# 6. Build Documentation
Mkdocs build
Если вы измените свою документацию, чтобы сделать это суре, и это будет сделано в соответствии со статьей 24
Вы можете также использовать `mkdocs serve` для обслуживания документации на localhost:8000

#commit, push, and create your pull request

!!!tip Подробнее о том, как и почему ormar работает так, см. документацию по API