Руководство для вкладчиков

Спасибо за ваш интерес к улучшению шаблона Hypermodern Python Cookiecutter. Этот проект является открытым исходным кодом под лицензией [MIT] и приветствует вклады в виде отчетов о багах, запросов на новые функции и pull requests.

Вот список важных ресурсов для вкладчиков:

• [Исходный код]
• [Документация]
• [Трекер ошибок]
• [Код поведения]

Как сообщить о баге

Сообщите о багах на [Трекере ошибок].

При создании отчета убедитесь, что вы ответили на следующие вопросы:

• Какая операционная система и версия Python вы используете?
• Какая версия этого проекта вы используете?
• Что вы делали?
• Что вы ожидали увидеть?
• Что вы увидели вместо этого?

Лучший способ получить исправление вашего бага — предоставить тестовый случай, и/или шаги для воспроизведения ошибки.

Как запросить новую функцию

Запросите новые функции на [Трекере ошибок].

Как настроить вашу среду разработки

Вам потребуется Python 3.7+ и следующие инструменты:

• [Cookiecutter]
• [Poetry]
• [Nox]
• [nox-poetry]

Создайте форк репозитория на [GitHub], и клонируйте форк на ваш локальный компьютер. Вы можете теперь сгенерировать проект из вашей версии разработки:

$ cookiecutter path/to/cookiecutter-hypermodern-python

Вы также можете захотеть отправить ваш сгенерированный проект на GitHub, и настроить [непрерывную интеграцию].## Как тестировать проект

Пожалуйста, обратитесь к [User Guide] для инструкций по запуску тестового набора локально.

Как отправить изменения

Откройте [pull request], чтобы отправить изменения в этот проект.

Ваш pull request должен соответствовать следующим правилам для принятия:

• Тестовый набор Nox должен пройти без ошибок и предупреждений.
• Включите unit тесты. Этот проект поддерживает 100% покрытия кода.
• Если ваши изменения добавляют функциональность, обновите документацию соответственно.

Не стесняйтесь отправлять ранние версии — мы всегда можем улучшить это.

Рекомендуется открыть issue перед началом работы над чем-либо. Это позволит обсудить подход с владельцами проекта и подтвердить его.

Как принять изменения

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

Перед принятием pull request пройдите по следующему списку проверок:

• Pull request должен пройти все проверки.
• Pull request должен иметь описательное название.
• Pull request должен быть помечен типом изменения (см. ниже). Заметки о выпуске заполняются автоматически заголовками и именами авторов объединенных запросов на слияние. Метки группируют запросы на слияние в разделы. Следующий список показывает доступные разделы, с соответствующими метками в скобках:- 💥 Критические изменения (breaking)
• 🚀 Новые функции (enhancement)
• 🔥 Удаления и устаревание (removal)
• 🐞 Исправления (bug)
• 🐎 Высокая производительность (performance)
• 🚨 Тестирование (testing)
• 👷 Непрерывная интеграция (ci)
• 📚 Документация (documentation)
• 🔨 Переработка (refactoring)
• 💄 Стили (style)
• 📦 Зависимости (dependencies)Для слияния запроса на внесение изменений выполните следующие шаги:

1. Нажмите Squash and Merge. (Выберите этот вариант из выпадающего меню кнопки слияния, если он не отображается.)
2. Нажмите Confirm squash and merge.
3. Нажмите Delete branch.

Как сделать выпуск

Для этого вам нужно быть поддерживателем проекта.

Перед выпуском пройдите по следующему списку проверок:

• Все запросы на слияние для выпуска были объединены.
• Основная ветка проходит все проверки.

Выпуски создаются путем публикации GitHub Release. Черновик выпуска поддерживается на основе объединенных запросов на слияние. Чтобы опубликовать выпуск, выполните следующие шаги:

1. Нажмите Edit рядом с черновиком выпуска.
2. Введите тег с новой версией.
3. Введите заголовок выпуска, также новую версию.
4. Редактируйте описание выпуска, если необходимо.
5. Нажмите Publish Release.

Номера версий соответствуют [календарной версионированию], в форме YYYY.MM.DD.

После публикации выпуска запускаются следующие автоматизированные шаги:- Тег Git применяется к репозиторию.

• [Read the Docs] строит новую стабильную версию документации. [календарная версионность]: https://calver.org/ [непрерывная интеграция]: https://cookiecutter-hypermodern-python.readthedocs.io/en/stable/quickstart.html#continuous-integration [cookiecutter]: https://cookiecutter.readthedocs.io/ [документация]: https://cookiecutter-hypermodern-python.readthedocs.io/ [GitHub]: https://github.com/cjolowicz/cookiecutter-hypermodern-python [система отслеживания задач]: https://github.com/cjolowicz/cookiecutter-hypermodern-python/issues [лицензия MIT]: https://opensource.org/licenses/MIT [nox]: https://nox.thea.codes/ [nox-poetry]: https://nox-poetry.readthedocs.io/ [poetry]: https://python-poetry.org/ [пулл-запрос]: https://github.com/cjolowicz/cookiecutter-hypermodern-python/pulls [Read the Docs]: https://cookiecutter-hypermodern-python.readthedocs.io/ [исходный код]: https://github.com/cjolowicz/cookiecutter-hypermodern-python [руководство пользователя]: https://cookiecutter-hypermodern-python.readthedocs.io/en/latest/guide.html#how-to-test-your-project[код поведения]: CODE_OF_CONDUCT.md