Инструкция по работе с Git

1. Установка Git на компьютер

Для начала, студентам нужно установить Git на свои компьютеры.

Windows:

1. Загрузите Git для Windows и запустите установочный файл.
2. Во время установки можно оставить настройки по умолчанию, но важно выбрать редактор для работы с Git (например, VSCode или Notepad++).
3. После завершения установки, откройте терминал (можно использовать Git Bash, который установится вместе с Git).

macOS:

1. Откройте терминал.
2. Введите команду:

   brew install git

   Если Homebrew не установлен, сначала нужно его установить через официальный сайт Homebrew.

Linux:

1. Откройте терминал.
2. В зависимости от дистрибутива используйте одну из следующих команд:
   • Ubuntu/Debian:

     sudo apt update
     sudo apt install git

   • Fedora:

     sudo dnf install git

Проверка установки:

После установки откройте терминал и введите команду:

git --version

Если вы увидите версию Git, значит всё установлено правильно.

---

2. Настройка Git

После установки Git важно настроить своё имя и email, так как они будут использоваться в каждом коммите.

Команды для настройки:

git config --global user.name "Ваше Имя"
git config --global user.email "ваш_email@example.com"

---

3. Создание Git-репозитория в организации

1. Перейдите по ссылке на страницу организации AlgorithmizationAndTechnologies.
2. Нажмите кнопку "New" рядом с "Repositories", чтобы создать новый репозиторий.
3. Введите имя репозитория, выберите его видимость (Public или Private) и добавьте README.md, если нужно.
4. Нажмите "Create repository".

---

4. Клонирование репозитория

После того как репозиторий создан, его нужно склонировать на локальный компьютер.

1. Перейдите на страницу репозитория.

2. Нажмите "Code" и скопируйте ссылку на репозиторий (HTTPS или SSH).

3. Откройте терминал и выполните команду:

   git clone https://github.com/AlgorithmizationAndTechnologies/имя-репозитория.git

   (Замените имя-репозитория на фактическое имя вашего репозитория.)

4. Перейдите в папку с репозиторием:

   cd имя-репозитория

---

5. Первый коммит

1. Создайте или измените файлы в репозитории (например, создайте файл test.pas).
2. Добавьте изменения в индекс:

   git add test.pas

3. Сделайте коммит:

   git commit -m "Добавил основной файл программы"

Советы по наименованию коммитов:

• Сообщение коммита должно быть кратким и содержательным. Обычно оно начинается с глагола в повелительном наклонении (например, "Добавил", "Исправил", "Обновил").
• Пример хороших сообщений:
  • "Добавил функцию вычисления среднего"
  • "Исправил ошибку с загрузкой файла"
  • "Обновил документацию"

---

6. Отправка изменений на GitHub

Чтобы отправить изменения в удалённый репозиторий на GitHub, выполните команду:

git push origin main

(Предполагается, что ветка по умолчанию называется main, если у вас другая ветка, замените на её название.)

---

7. Основные команды Git для работы

• Проверка статуса репозитория:

  git status

  Эта команда показывает, какие файлы были изменены и какие ещё не были закоммичены.

• Просмотр истории коммитов:

  git log

• Создание новой ветки:

  git checkout -b имя-ветки

• Слияние ветки: Сначала переключитесь на основную ветку (main):

  git checkout main

  Затем выполните команду для слияния ветки:

  git merge имя-ветки

• Отмена изменений: Если вы хотите отменить локальные изменения в файле:

  git checkout -- имя_файла

---

8. Полезные советы

• Чаще делайте коммиты: Лучше делать небольшие коммиты с понятными сообщениями, чем один большой коммит со всеми изменениями.
• Регулярно синхронизируйте изменения: Часто делайте git pull, чтобы всегда иметь актуальную версию кода с сервера:

  git pull origin main

---

Правила написания коммитов

Для того чтобы команда разработчиков могла легко отслеживать изменения и понимать суть каждого коммита, важно придерживаться определённого стандарта написания сообщений. Это помогает поддерживать читаемость истории изменений и упрощает поиск нужных правок в будущем.

Стандартные теги для коммитов:

Теги указываются в начале сообщения коммита (заглавными буквами), чтобы сразу было понятно, какого рода изменения в нём содержатся.

1. CREATE
   Используется для создания новых файлов, функций, сущностей или любой новой логики.

   • Пример:

     git commit -m "CREATE: добавление новой модели в AbstractClass User"

2. UPD (Update)
   Применяется, когда вносятся улучшения или изменения в уже существующий код, но при этом не исправляются ошибки.

   • Пример:

     git commit -m "UPD: обновление описания API в README"

3. FIX
   Этот тег используется для исправления ошибок в коде (багов).

   • Пример:

     git commit -m "FIX: исправлен баг с некорректной загрузкой данных"

4. DEL (Delete)
   Применяется для удаления файлов, кода, сущностей или функционала.

   • Пример:

     git commit -m "DEL: удаление неиспользуемой функции <ПоставитьСтудентамОценку5>"

5. REFACTOR
   Используется при изменении структуры кода без изменения его функциональности. Например, улучшение читаемости или реорганизация кода.

   • Пример:

     git commit -m "REFACTOR: разделение файла main.py на несколько модулей"

6. DOCS
   Для обновления или добавления документации.

   • Пример:

     git commit -m "DOCS: добавлен раздел о настройке проекта"

7. TEST
   Используется для добавления или обновления тестов в проекте.

   • Пример:

     git commit -m "TEST: добавлен unit-тесты для функции calculateAverage"

8. STYLE
   Применяется для изменений, касающихся только стиля кода, например, форматирования, пропусков строк, табуляции и т.д., без изменения логики.

   • Пример:

     git commit -m "STYLE: код приведён к PEP8"

9. MERGE
   Используется для слияния веток.

   • Пример:

     git commit -m "MERGE: слияние ветки feature/authentication с master"

10. CHORE
    Этот тег применяется для задач, которые не относятся к коду, например, обновление зависимостей или настройка сборки проекта.

    • Пример:

      git commit -m "CHORE: обновил версию пакета Django до 5.0 и мигрировал изменения"

---

Структура сообщений коммитов

Сообщения коммитов должны быть короткими и конкретными, описывать суть изменений. Обычно используются следующие правила:

1. Первое слово — глагол: Это делает сообщение коммита более прямым и описательным.
2. Не более 50 символов в первой строке: Заголовок должен быть кратким и лаконичным, чтобы его было удобно читать.
3. Пустая строка после заголовка (если есть описание).
4. Подробное описание (если нужно): Если изменения сложные и требуется больше деталей, то после заголовка можно добавить развёрнутое описание изменений, чтобы пояснить, что было сделано и почему.

Пример правильного коммита:

FIX: исправлен баг с загрузкой данных

Добавил проверку на пустое значение в методе processData,
что устраняет ошибку при загрузке файлов без данных.

Общие советы:

• Коммиты должны быть атомарными: То есть каждый коммит должен решать одну конкретную задачу. Например, если вы исправляете баг и добавляете новую функциональность, лучше сделать это в двух отдельных коммитах.
• Коммит как документ: Представьте, что каждый коммит — это небольшой документ, который должен объяснять, зачем было сделано изменение, а не только что было сделано.
• Используйте английский язык в проектах с международной командой, если это может помочь пониманию истории изменений другими разработчиками.

---