3.7 KiB
Read these guidelines in other languages |
---|
Как создать Pull Request (Пулл Реквест)
Как сделать хороший заголовок для Pull Request:
Создавая Pull Request (PR), воспользуйтесь данной таблицей, чтобы решить, как правильно озаглавить PR в формате:
fix/feat/chore/refactor/docs/perf (scope): PR Title
Например: fix(learn): Fixed tests for the do...while loop challenge
.
Область | Описание |
---|---|
learn ,curriculum |
Для PR'ов, которые вносят изменения в учебный план. |
client |
Для PR'ов, которые вносят изменения в логику клиентской платформы или пользовательский интерфейс. |
guide |
Для PR'ов, которые вносят изменения в инстукции. |
docs |
Для PR'ов, которые вносят изменения в документацию. |
Создание Пулл Реквеста (PR)
-
После того, как вы внесёте какие-нибудь изменения в свой форк репозитория, GitHub предложит вам создать PR
-
По умолчанию все PR создаются в ветку
master
основного репозитория freeCodeCampПри создании PR, убедитесь, что в поле "base fork" указан репозиторий freeCodeCamp/freeCodeCamp
-
Нажать на кнопку "Create pull request", для создания PR из вашей верки в ветку
master
freeCodeCamp. -
В поле описания PR добавьте более подробный отчёт сделанных вами изменений и причины по которым появилась такая необходимость
-
Вам будет предоставлен шаблон, который содержит контрольные список пунктов, которые вам необходимо выполнить, прежде чем вы создадите PR.
-
Заполните эти пункты. Опираясь на них, будет приниматься решение о рассмотрении и принятии вашего PR
-
Если PR предназначен для исправления существующей ошибки/проблемы, то в конце описание вашего PR добавьте ключевое слово
closes
и #xxxx (где xxxx это номер выпуска). Например:closes #1337
. Так GitHub поймёт, что при успешном принятии PR нужно автоматически закрыть Issue с указанным номером
-
-
Укажите, тестировали ли вы локальную копию сайта или нет.
Тестирование необходимо, когда вы не просто меняете какой-то текст (например, статью руководства), а изменяете JavaScript, HTML или CSS файлы, которые могут изменить функциональность или макет страницы.