Внесение вклада в Starlette

Команда Starlette рада приветствовать ваши вклады. Этот документ поможет вам подготовиться к внесению вклада в Starlette!

Чтобы отправить новый код проекту, вам потребуется:

• Создайте форк репозитория.
• Клонируйте свой форк на вашем локальном компьютере: git clone https://github.com/<username>/starlette.git.
• Установите Starlette локально и запустите тесты: ./scripts/install, ./scripts/test.
• Создайте ветку для вашего работы, например: git checkout -b fix-some-bug.
• Не забудьте включить тесты и обновления документации при необходимости.
• Когда будете готовы, отправьте изменения на удалённый сервер: git push origin fix-some-bug.
• [Откройте запрос на слияние][pull-request].

Установка

Примечание: Эти скрипты предназначены для использования с Linux и macOS, но мы будем рады принять запросы на вливание, чтобы помочь нам сделать их более совместимыми.

Используйте скрипт install, чтобы установить зависимости проекта в виртуальной среде.

./scripts/install

Для использования конкретной версии Python используйте опцию -p, например:

./scripts/install -p python3.7

Запуск тестов

Тесты написаны с использованием [pytest] и расположены в директории tests/.

Примечание: перед тем как делать какие-либо изменения в коде, следует запустить тесты, чтобы убедиться, что всё работает корректно.

Мы предоставляем отдельный скрипт для запуска тестов в надёжном режиме. Запустите его командой:```bash ./scripts/test

По умолчанию, тесты, связанные с базами данных, исключены. Чтобы включить их, установите переменную окружения `STARLETTE_TEST_DATABASES`. Это должна быть строка, разделенная запятыми, содержащая URL адреса баз данных.

```bash
# Любое из следующих значений допустимо для запуска тестов баз данных...
export STARLETTE_TEST_DATABASES="postgresql://localhost/starlette"
export STARLETTE_TEST_DATABASES="mysql://localhost/starlette_test"
export STARLETTE_TEST_DATABASES="postgresql://localhost/starlette, mysql://localhost/starlette_test"

Линтер

Мы используем [Black][black] как форматтер кода. Для запуска его вместе с несколькими другими линтерами мы предоставляем отдельный скрипт:

./scripts/lint

Если линтер имеет замечания относительно кода, он автоматически исправляет стиль кода.

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

Документация

Документация создаётся с помощью [MkDocs], генератора сайта на основе Markdown. Чтобы запустить сайт с документацией в режиме горячего перезапуска (полезно при редактировании документов), выполните команду $ mkdocs serve в корневой директории проекта.

Для вашего удобства конфигурация сайта с документацией находится в файле mkdocs.yml.

Пожалуйста, обратитесь к [документации MkDocs][MkDocs] для получения дополнительной информации о использовании, включая методы добавления новых страниц.[issues]: https://github.com/encode/starlette/issues/new [pull-request]: https://github.com/encode/starlette/compare [pytest]: https://docs.pytest.org [pytest-cov]: https://github.com/pytest-dev/pytest-cov [black]: https://github.com/psf/black [MkDocs]: https://www.mkdocs.org