Перейти к основному содержимому

Как внести вклад (для студентов)

Если преподаватель попросил вас помочь с улучшением документации или вы нашли ошибку/опечатку, следуйте этой инструкции.

Пошаговая инструкция: Pull Request из форка​

1. Создайте форк репозитория​

  1. Перейдите на GitHub репозиторий
  2. Нажмите кнопку "Fork" в правом верхнем углу
  3. Дождитесь создания форка (обычно несколько секунд)

2. Склонируйте свой форк на компьютер​

# Замените YOUR_USERNAME на ваш GitHub username
git clone https://github.com/YOUR_USERNAME/docs.git
cd docs

3. Настройте удаленный репозиторий (опционально, но рекомендуется)​

# Добавляем оригинальный репозиторий как "upstream"
git remote add upstream https://github.com/efremovnv/docs.git

# Проверяем, что всё настроено правильно
git remote -v

4. Создайте ветку для ваших изменений​

# Создаем новую ветку с понятным названием
git checkout -b fix/исправление-опечатки-в-lab6
# или
git checkout -b docs/добавление-примера-кода

Рекомендации по названиям веток:

  • fix/ - для исправлений ошибок
  • docs/ - для добавления/обновления документации
  • feat/ - для новых функций (редко для студентов)

5. Внесите изменения​

Откройте нужные файлы в редакторе и внесите изменения:

  • Исправьте опечатки
  • Добавьте недостающую информацию
  • Улучшите формулировки
  • Добавьте примеры кода

6. Проверьте изменения локально (опционально, но рекомендуется)​

cd website
npm install
npm start

Откройте http://localhost:3000 и проверьте, что ваши изменения выглядят правильно.

7. Закоммитьте изменения​

# Вернитесь в корень проекта (если были в website/)
cd ..

# Добавьте измененные файлы
git add website/docs/computer-organization/labs-sem7/lab6.md

# Создайте коммит с понятным сообщением
git commit -m "docs: исправлена опечатка в лабораторной работе 6"

Рекомендации по сообщениям коммитов:

  • docs: исправлена ошибка в lab6.md - исправление ошибки
  • docs: добавлен пример кода в lab7.md - добавление контента
  • fix: исправлена ссылка на теорию - исправление ссылки
  • style: улучшено форматирование - изменение форматирования

8. Отправьте изменения в ваш форк​

# Отправляем ветку в ваш форк на GitHub
git push origin fix/исправление-опечатки-в-lab6

Если это первый раз, Git может попросить настроить upstream:

git push --set-upstream origin fix/исправление-опечатки-в-lab6

9. Создайте Pull Request​

  1. Перейдите на страницу вашего форка: https://github.com/YOUR_USERNAME/docs

  2. GitHub покажет баннер с предложением создать Pull Request - нажмите "Compare & pull request"

  3. Или перейдите на страницу оригинального репозитория и нажмите "New Pull Request", затем выберите ваш форк и ветку

  4. Заполните форму Pull Request:

    • Title (Заголовок): Краткое описание изменений

      • ✅ Хорошо: Исправлена опечатка в лабораторной работе 6
      • ❌ Плохо: Изменения или Fix

    • Description (Описание): Подробное описание того, что вы изменили и почему

      ## Что изменено
      - Исправлена опечатка в разделе "Цель работы"
      - Добавлен недостающий пример кода

      ## Где находится
      `website/docs/computer-organization/labs-sem7/lab6.md`, строки 15-20

  5. Нажмите "Create Pull Request"

10. Дождитесь проверки​

Преподаватель проверит ваш Pull Request и либо:

  • ✅ Approve и Merge - изменения будут приняты
  • 💬 Оставит комментарии - нужно будет внести правки
  • ❌ Закроет - если изменения не подходят (редко)

Если нужно внести правки:

  1. Внесите изменения в той же ветке на вашем компьютере
  2. Создайте новый коммит: git commit -m "docs: исправления по замечаниям"
  3. Отправьте изменения: git push
  4. Pull Request обновится автоматически

Быстрый старт (краткая версия)​

# 1. Форк на GitHub (через веб-интерфейс)

# 2. Клонирование
git clone https://github.com/YOUR_USERNAME/docs.git
cd docs

# 3. Создание ветки
git checkout -b fix/название-изменения

# 4. Внесение изменений (в редакторе)

# 5. Коммит
git add .
git commit -m "docs: описание изменений"

# 6. Отправка
git push origin fix/название-изменения

# 7. Pull Request (через веб-интерфейс GitHub)

Частые вопросы​

Q: Что делать, если я случайно сделал коммит в main ветку?
A: Создайте новую ветку из текущего состояния: git checkout -b fix/название, затем отправьте её. Если вы не уверены, как это сделать, обратитесь за помощью к мейнтейнеру проекта.

Q: Как обновить свой форк, если в оригинальном репозитории появились новые изменения?
A:

git fetch upstream
git checkout main
git merge upstream/main
git push origin main

Q: Можно ли делать несколько Pull Request одновременно?
A: Да, создайте разные ветки для разных изменений.

Q: Что делать, если Pull Request закрыли, но я хочу исправить?
A: Создайте новый Pull Request с исправлениями или откройте закрытый PR заново (если он не был удален).

Полезные ссылки​

Следующие шаги​

После того, как вы освоили процесс создания Pull Request, изучите: