Использование GitHub¶
Info
Кнопки, текст или иконки, на которые нужно обратить внимание, отмечены на скриншотах фиолетовым цветом
Регистрация¶
Для начала нужно зарегистрироваться на сайте GitHub
Форк¶
После регистрации нужно перейти в репозиторий с гайдами и нажать кнопку Fork
Выбор куда форкать¶
Создавая форк убедитесь что в Owner выбран ваш аккаунт (если вы только зарегистрировались, то он будет единственный
доступный). Нажмите кнопку Create fork
Рабочее пространство¶
Как открыть¶
Для создания гайда в браузере нажмите на зелёную кнопку Code, затем Codespaces и Create codepspace on master
Само рабочее пространство¶
После этого у вас откроется Codespace - онлайн рабочее пространство
Слева вы можете создавать папки и файлы щелчком правой кнопки мыши будто работаете локально
Создание первых файлов¶
Создайте папку с именем вашего гайда (в данном случае how_to_contibute) и в нём файл index.md
Затем выполните шаги, выполненные в пункте краткое описание
Проверка как выглядит гайд¶
Для проверки как выглядит гайд можно использовать встроенные средства онлайн-редактора
Терминал¶
Сначала отройте терминал, нажав на значок справа сверху.
Снизу появится консоль
Установка зависимостей¶
Установите необходимые пакеты командой pip install -r dependencies.txt
Локальный старт¶
После этого введите команду python -m mkdocs serve чтобы запустить гайды
Просмотр¶
Перейдите внизу на вкладку "Порты" и нажмите "Открыть в браузере" - у вас откроется главная страница с гайдами и вы сможете просмотреть что получилось
Фиксация изменений¶
Открытие SCM¶
Когда вы завершили работу над гайдом перейдите в третью вкладку слева сверху
Добавление файлов¶
и нажмите на значок "+" рядом с каждым файлом и папкой, чтобы они переместились в секцию "Промежуточные изменения"
Затем нужно ввести любое сообщение в поле "Сообщение"
Фиксация изменений¶
и нажать "Фиксация"
Синхронизация изменений¶
После необходимо нажать на "Синхронизировать изменения"
и нажать "Ok" во всплывающем окне
Добавление в общий репозиторий¶
Теперь необходимо создать запрос на внесение гайда в общий репозиторий
Создание PR¶
Для этого вернитесь на страницу вашего форкнутого репозитория и нажмите "Contribute"
а затем "Open pull request"
На открывшейся странице нажмите "Create pull request"
Поздравляю, вы отправили свой первый гайд на проверку модераторами!
Как только он будет просмотрен модераторами, то мы либо сразу добавим ваш гайд в наш репозиторий, либо оставим комментарии к нему
Статус гайда¶
Увидеть был ли Ваш гайд внесён в общий репозиторий или нет можно перейдя по ссылке Pull Request на странице общего репозитория и найдя там свой гайд
Комментарии к гайду¶
Если к вашему гайду оставили комментарии и вы согласны с ним (а если не согласны - перейдите к пункту закрытие комментариев),
то вам нужно вновь вернуться в рабочее пространство.
Редактирование гайда по комментарию¶
Там, в соответствующем файле, вы сможете увидеть тот же самый комментарий, нажав на иконку диалога слева
Фиксация изменений¶
Исправив замечание / дополнив гайд, повторите фиксацию изменений.
Закрытие комментариев¶
Чтобы закрыть комментарий найдите свой гайд во вкладке Pull Requests и откройте его. Затем напишите
свой ответ в поле Reply и нажмите зелёную кнопу Comment, а после - Resolve conversation. При этом хорошим тоном
будет упомянуть автора комментария через собачку @
