From 8d43369df3b887ea615ec30dfc212736ed2a4f94 Mon Sep 17 00:00:00 2001 From: SecondThundeR Date: Mon, 7 Nov 2022 02:15:10 +0300 Subject: [PATCH] docs(CONTRIBUTING): update pull requests section Remove note about installation of Python 3.8.10 Fix small style issues --- CONTRIBUTING.md | 35 ++++++++++++----------------------- 1 file changed, 12 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e4fbda5..395b42a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Пам-парам. Приветствую смотрящих -## Последнее изменение: 01.05.2022 +## Последнее изменение: 07.11.2022 Добро пожаловать в пометку контрибьютора. Здесь изложены некоторые правила, которые помогут правильно оформить код в соответствиями с правилами проекта @@ -52,43 +52,31 @@ _Кто-то дошел до этого момента? Удивительно.. Поскольку данный проект был создан и разрабатывается на macOS, сначала опишу что нужно сделать тем, кто хочет разрабатывать тоже на ней: -1. В первую очередь, необходимо установить нужные версии Python для проверки работоспособности. +1. В первую очередь, необходимо установить последнюю актуальную версию Python. Сделать это можно с помощью Homebrew и пару команд: - Для начала установите Homebrew, если он у вас отсутствует. Информация об установке находится [здесь](https://brew.sh/index_ru) - - Далее, используя две команды, установите две версии Python: ```brew install python@3.8``` и ```brew install python@3.10``` _(На данный момент, это самая последняя версия Python)_ + - Далее введите следующую команду: ```brew install python``` 2. Установите Poetry: ```brew install poetry``` 3. Находясь в папке проекта, введите в Терминале: ```poetry shell``` и ```poetry install```. Это запустит виртуальное окружение Poetry и установит необходимые зависимости. - > По умолчанию, Poetry выберет последнюю версию Python, чтобы использовать Python 3.8 в окружении, введите в Терминале: ```poetry env use 3.8``` 4. Если вы используете какие-нибудь IDE, не забудьте настроить виртуальное окружение и там Пользователям Windows нужно пройти пару этапов: -1. Установите [Python 3.8.10](https://www.python.org/downloads/release/python-3810/) и [последний Python](https://www.python.org/downloads/) на текущий момент - > Почему 3.8.10? А, просто для 3.8.13 нет нормальных установщиков :( - > - > _(Если конечно, вы хотите собрать Python из сурсов, то можете собрать и 3.8.13)_ +1. Установите [последнюю актуальную версию Python](https://www.python.org/downloads/) 2. Установите Poetry: - Если вы используете [Bash on Windows](https://python-poetry.org/docs/#osx--linux--bashonwindows-install-instructions) - Если вы используете [Powershell](https://python-poetry.org/docs/#windows-powershell-install-instructions) 3. Выполните пункты 3 и 4 из гайда выше для юзеров macOS - > Если вы не хотите устанавливать Python 3.8 в PATH, то можете запускать виртуальное окружение, передавая путь до ```python.exe``` - > - > Например: ```poetry env use "C:\Program Files\Python38\python.exe"``` Пользователям Linux нужно пройти пару этапов: -1. Установите Python 3.8.13 и Python 3.10 +1. Установите последнюю актуальную версию Python _(Лучше загуглить, чем писать тут как это делать под каждый дистрибутив)_ 2. Установите Poetry используя [официальную команду](https://python-poetry.org/docs/#osx--linux--bashonwindows-install-instructions) > Если же у вас не стоит нужного алиаса под команду ```python```, то не забудьте поменять вызов интерпретатора в конце команды 3. Выполните пункты 3 и 4 из гайда выше для юзеров macOS - > Если возникнут какие-либо проблемы с Python или Poetry, то к сожалению, вам придется решать их самостоятельно, так как разработчик не имеет опыта разработки на Linux :c - -> **Небольшое помечание:** -> -> Ввиду того, что тесты отсутствуют, минимальная проверка в виде работоспособности на Python 3.8 и самом последнем приветствуется. -> -> В противном случае, придется исправлять функционал для его работы на старой версии Python + > Если возникнут какие-либо проблемы с Python или Poetry, то к сожалению, вам придется решать их самостоятельно, + > так как разработчик не имеет опыта разработки на Linux :c #### Подготовка к отправке пулл реквеста @@ -99,15 +87,16 @@ _(Лучше загуглить, чем писать тут как это дел Чтож, вам осталось пройти пару этапов перед финальным ~~боссом~~ пулл реквестом: 1. Для начала, убедитесь, что ваши новые методы или классы имеют документацию _(можно даже базовую)_. - - Данный проект использует документацию типа reStructuredText, пример которой вы можете найти в интернете или в имеющихся файлах. + Данный проект использует документацию типа reStructuredText, пример которой вы можете найти в интернете + или в имеющихся файлах. 2. Запустите `pre-commit install` для установки необходимых хуков для проверки файлов при коммите. Если будут найдены какие-либо ошибки, вы будете уведомлены во время попытки коммита. - > Если же вас преследуют ошибки, которые никак не убираеютя, оставьте их и попробуйте сделать коммит с флагом `--no-verify`. + > Если же вас преследуют ошибки, которые никак не убираеютя, оставьте их и попробуйте + > сделать коммит с флагом `--no-verify`. > > В дальнейшем, если ваши изменения будут значимыми, после слияния, разработчик попробует решить ошибки самостоятельно - > _**(Но это не значит что нужно оставлять все ошибки!!1!!!111!! :C)**_ + > _**(Но это не значит что нужно оставлять все ошибки!!1!!!111!! :C)**_ Также можно запустить команду `pre-commit run --all-files` для запуска хуков без иницирования коммита. 3. Убедитесь, что проект собирается, введя в Терминал команду: ```poetry build```