[HELP] Review DOCS #5
Description
1) сделайте коммит
1.1 Выберите файлы для коммита:
1.2 Инструкция в github desktop:
выберите файл для фиксации в коммит, в коммите должны участвовать только файлы которые связаны с названием коммита
1.3 Инструкция в vs code/cursor:
выберите файл для фиксации в коммит, в списке staged changes должен быть ОДИН файл
1.4 Что писать в заголовке и описании коммита:
Заголовок коммита:
Имя ишюьса (ссылка на ишьюс в круглых скабках)
Описание коммита:
Closes ссылка на ишьюс
1.5 Пример коммита в VS code/Cursor:
1.6 Пример коммита на сайте github/Github desktop:
1.7 Конвертация файлов *.ipynb в формат *.py
Во время выполнения коммита будут автоматически запущены линтеры и утилита jupytext. Утилита jupytext конвертирует ваши файлы *.ipynb в формат *.py.
Если все сделано правильно, ваши файлы *.ipynb окажутся в коммите (соответственно, они пропадут из списка отслеживаемых файлов (вкладка Source Control в VSCode – кнопка с двумя листочками)). Но в списке отслеживаемых файлов окажутся новые, сконвертированные файлы в формате *.py. Эти файлы также надо закоммитить. Это можно сделать двумя способами:
- Создать новый коммит с этими файлами согласно инструкции выше.
- Использовать команду git commit --amend (кнопка Commit Amend в VSCode). Это команда добавит файлы из Stage в последний коммит без создания нового коммита.
В результате каждому файлу с расширением ipynb должен соответствовать файл с таким же именем и расширением py, например:
script.ipynb ---> script.py
test.ipynb ---> test.py
log.ipynb ---> log.py
Если какие-то файлы не были сконвертированы автоматически, вы можете сделать это вручную командами:
jupytext --to py *.ipynb – конвертирует все файлы ipynb в текущей директории в py
или
jupytext --to py script.ipynb reports/log.ipynb – конвертирует только указанныне файлы (в примере файл script.ipynb и log.ipynb из reports)
спасибо rizespbya, за улучшение
2) Отправьте пул реквест
2.1 Отправьте пул реквест https://github.com/ВСТАВЬТЕ_СЮДА_СВОЙ_ЛОГИН/Data-Science-For-Beginners-from-scratch-SENATOROV/pulls
2.2 Нажмите зелёную кнопку
2.3 прочитайте документацию и заполните название и описание пулл реквеста
Что писать в заголовке и описании пулл реквеста:
Заголовок коммита:
Имя ишюьса (ссылка на ишьюс в круглых скабках)
Описание коммита:
Closes ссылка на ишьюс
2.4 Нажимаем "create pull requests"
3) Выбор файла для ревью
Ревью файлов .py
3.1 Выбираем файл который вы хотите чтобы проверили,
3.2 На ревью предоставляются файлы формата .py.
3.3 выделяем все строки в файле
3.4 нажимаем на самой нижней строке на синий "+", у вас появится номера строк которые вы просите ревьювить, инструкция как выделять строки
3.5 обязательно нажимайте сабмит ревью
Ревью PDF
3.6 пишем "сделай ревью" и нажимаем "start review"
3.7 проделайте тоже самое с другими файлами, если вы хотите чтобы проверили несколько файлов
3.8 обязательно нажимайте сабмит ревью
4) Проверьте что нет открытых тасков:
если они есть сначала сделайте их ревью.
5) Как делать ревью?
5.0 Проверьте что вы указаны как ревьювер
5.1 Отправьте заявку на вступление в команду,
5.2 отправьте в чат хэштег #group_0 и укажите @arm_naruto
5.3 Реплайте сообщение
5.4 Нажмите на ревью
5.5 Проверьте что нет ошибок и все линтеры успешно прошли
5.6 Сабмите ревью
5.7 Закройте пул реквест
5.8 Если у ревьюера есть замечания, нужно сообщить в чат с прикрепленной ссылкой на комментарий (в случае если их несколько - на последний) с упоминанием ника автора
5.9 Реплайте сообщение
5.9.1 Обязательно ведите отчётность ревью
После того как вы сделали ревью, вы можете запросить чтобы вам сделали ревью.
6) Запрос Ревью:
Ревью от ваших одногруппников
6.0 Найдите в расписании ответственного за ревью и выберите его в списке
6.1 Кидаем ссылку на ваш pull requests сюда
6.2 В посте указываете хэштег с номером группы и обязательно логин телеграм ревьювера
6.3 Сделайте reply вашего сообщения и напишите во втором сообщении только тег #open
6.4 Если на ваше сообщение ответили #accepted надо удалить тег #open.
6.5 Если в ходе ревью вас попросили исправить ошибки,нужно оставить комментарий(и) к замечаниям ревьювера после их отработке, а затем отправляет в чат ссылку на свой последний комментарий с упоминанием ревьюера
7) Обновите статус
После того как вам сделали ревью меняете статус на closes, благодарите за ревью
8) Сделайте мёрж вашей ветки в main
- откройте пул реквест в вашем репозитории см скриншот
- напишите название и описание вашего пул реквеста, в название
имя ишьюса (ссылка на ишьюс)в описанииcloses ссылка на ишьюс - убедитесь что всё зелёное и сделайте merge см скриншот