Процесс Pull Request
Пошаговое руководство по созданию pull request в проект.
подсказка
Новичок в open source? Рекомендуем Open Source Contributor Guide — подробное руководство для контрибьюторов с нуля.
Пошаговый workflow
1. Задача
- Поищите существующую задачу в issues
- Если подходящей нет — создайте новую, где опишите, что и зачем нужно сделать
- Дождитесь обратной связи — возможно, ваше предложение уже реализовано или требует уточнения
2. Fork и клонирование
-
Создайте fork проекта ветки
developв свой репозиторий на GitHub
-
Клонируйте свой репозиторий на локальный ПК:
git clone https://github.com/ВАШАКАУНТ/tools_ui_1c.git
cd tools_ui_1c
3. Ветка
Всегда работайте от ветки develop:
git checkout develop
git pull origin develop
git checkout -b feature/краткое-описание-изменения
important
Убедитесь, что ваш fork синхронизирован с оригинальным репозиторием перед созданием новой ветки.
4. Разработка
- Настройте окружение для работы
- Соблюдайте правила оформления кода
- После завершения доработок проверьте работоспособность
5. Сборка и проверка
Соберите расширение по инструкции и убедитесь, что:
- проект собирается без ошибок
- инструменты корректно работают в 1С
- не появилось ли новых проблем в существующих инструментах
- исправлены все замечания анализатора Sonar
6. Pull Request
- Отправьте ветку в свой fork
git push origin feature/краткое-описание-изменения
-
Откройте Pull Request на GitHub
-
ВАЖНО: выбирайте целевую ветку
develop, неmaster -
В описании PR укажите:
- ссылку на issue (если есть), используя
Close #Nдля автоматического закрытия задачи при слиянии - что делает изменение
- как протестировать
- ссылку на issue (если есть), используя
Подробный гайд по оформлению PR и работе с git: Open Source Contributor Guide
7. Ревью
- Дождитесь ревью своих изменений
- Будьте готовы внести правки по замечаниям
- После одобрения PR будет влит в
develop
Важно
- Ветка
develop, а неmaster— все PR идут только в develop - Синхронизируйте fork перед началом работы
- Не делайте rebase после создания PR без необходимости
- Один PR — одна задача (или логически связанная группа изменений)
Полезные ссылки
- Open Source Contributor Guide — подробное руководство для контрибьюторов: от настройки git до создания PR
- Pro Git Book — книга по Git на русском
- Learn Git Branching — интерактивное изучение ветвления в Git
- Oh Shit, Git!?! — типичные проблемы с Git и их решение
- Keep a Changelog — рекомендации по ведению CHANGELOG