Как внести изменения в документацию RS School
Если вы заметили неточность или опечатку в документации школы, или в условии задания, их желательно исправить.
Репозиторий с документацией здесь
При необходимости, можно обсудить изменения в issue, например. Но если содержание исправлений для вас очевидно, лучше создать Pull Request.
Как добавить изменения в чужой репозиторий
Отправляя Pull Request, вы предлагаете автору репозитория и всем заинтересованным лицам рассмотреть внесённые вами изменения и влить их в проект. Если изменения разумны и целесообразны, ваш Pull Request будет принят.
Покажу как это сделать на примере репозитория https://github.com/rolling-scopes-school/docs
1. Делаем собственную копию репозитория.
Для этого нажимаем кнопку "Fork" на странице репозитория.
В результате копия репозитория появляется в вашем аккаунте.
Адрес вашей копии репозитория содержит имя вашего аккаунта на гитхабе.
- Оригинальный репозиторий
https://github.com/rolling-scopes-school/docs - Созданная копия
https://github.com/irinainina/docs
2. Клонируем собственную копию репозитория себе на компьютер
git clone https://github.com/irinainina/docs
3. Привязываем локальную копию к оригинальному репозиторию
Для этого заходим в папку склонированного репозитория и выполняем две команды:
git remote add upstream https://github.com/rolling-scopes-school/docs
git fetch upstream
4. Создаём собственную ветку разработки
Имя ветки, как правило, указывает на содержание правок. Предположим, что наша ветка будет называться fix-typo. Создаёт новую ветку fix-typo и делает её активной команда:
git checkout -b fix-typo
В этой точке мы уже можем править код и добавлять в него необходимые изменения.
5. Добавляем изменения в собственную копию репозитория
Как только вы сделали работу (или её часть), отправьте её в собственную копию репозитория на GitHub. Для этого выполните команды:
git add .
git commit -m "feat: add fix-typo"
git push origin fix-typo
6. Возвращаем изменения: Pull request
Итак, всё сделано. Вы написали код, он у вас в ветке fix-typo как у вас на компьютере, так и на GitHub. Осталось только отправить его в оригинальный репозиторий.
Заходите на страницу вашей копии репозитория на GitHub, выбираете ветку fix-typo и нажимаете кнопку Pull Request.
Добавляете название и описание ваших изменений и нажимаете на кнопку "Create pull request".
Что дальше?
Следите за вашим Pull Request. Что прокомментируют люди, что скажет мэйнтэйнер, примет или нет предложенные вами правки.
По такому же принципу можно исправлять ошибки в репозитории с заданиями курса или даже предлагать свои собственные таски.
Изменится только имя репозитория, но сам принцип работы с репозиторием остаётся неизменным. Потому что именно он лежит в основе совместной работы на GitHub и создания open-source проектов.
