This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Инструкция по работе с Git (сокращенная)
Аннотация
Описывается полный цикл работы с репозиторием в процессе выполнения задач. Подразумевается, что задача уже создана и номер задачи известен. Приводятся описания последовательности действий для случаев: когда новая задача только принята к исполнению, а также, когда работа над задачей ведется уже некоторое время.
Повседневный рабочий цикл над новой задачей
Далее описывается цикл работы с репозиторием «с нуля» (когда нет текущих feature-веток в работе). Подразумевается, что IDE открыта, открыт терминал в папке локального репозитория.
1. Получить актуальную версию
Прежде всего, требуется получить актуальную версию main-ветки, поскольку создание feature-веток должно осуществляться именно от нее. Для этого требуется выполнить:
git checkout main
git pull origin main
2. Создание ветки задачи
Создайте новую ветку от актуального main.
git checkout -b edit/task-0015
(Такая команда создаст ветку для редактирования существующей страницы в рамках задачи #15.)
3. Выполнение полезной работы
Начните выполнять полезную работу в созданной feature-ветке. В случае, если в результате работы созданы новые файлы, добавьте их в индекс Git:
git add .
Если требуется добавить конкретный файл, то выполните:
git add path/to/file.md
(Альтернатива: Ctrl + Alt + A в PyCharm.)
В процессе работы почаще создавайте коммиты согласно Инструкции по созданию коммитов.
4. Отправка изменений и создание Pull Request
Когда задача завершена:
- Отправьте ветку на Forgejo:
git push origin edit/task-0015
Именование веток
Используется основная ветка main и короткоживущие feature-ветки следующих типов:
new/task-NNNN— добавление новой страницы/раздела документации;edit/task-NNNN— редактирование (с целью расширения, развития) имеющихся страниц;fix/task-NNNN— корректура, исправление ошибок, правка документации (с целью уточнения, актуализации, но не с целью развития).
В имени ветки NNNN — это номер задачи (всегда 4 знака). Другие префиксы могут создаваться по необходимости.
Пример:
git checkout -b new/task-0123
(Данная команда создает ветку для создания новой страницы документации в рамках задачи #123.)