Шаблоны фиксации

Шаблоны фиксации

Научитесь писать семантические и профессиональные коммиты

Шаблоны фиксации

Согласно документации по обычным коммитам, семантические коммиты — это простое соглашение, используемое в сообщениях о коммитах. Это соглашение определяет набор правил для создания явной истории коммитов, что упрощает создание автоматизированных инструментов. Эти коммиты помогут вам и вашей команде легче понять, какие изменения были внесены в зафиксированный фрагмент кода. Эта идентификация происходит с помощью слова и смайлов, которые определяют, является ли зафиксированная фиксация изменением кода, обновлением пакета, документацией, визуальным изменением, тестом...

Типы коммитов

Семантические коммиты имеют следующие структурные элементы (типы), которые сообщают пользователю вашего кода о намерении вашего коммита.

✨

feat

Указывает, что ваш фрагмент кода включает новую функциональность (связанную с MINOR в семантическом управлении версиями).

git commit -m ":sparkles: feat: adicionar autenticação de usuário"
🐛

fix

Указывает, что ваш зафиксированный фрагмент кода решает проблему (исправляет ошибку), он связан с PATCH в семантическом управлении версиями.

git commit -m ":bug: fix: corrigir loop infinito na validação"
📚

docs

Указывает, что в документацию были внесены изменения, например в файл README вашего репозитория (не включает изменения кода).

git commit -m ":books: docs: atualizar README com instruções"
💄

style

Указывает на наличие изменений, связанных с форматированием кода, точками с запятой, пробелами, ворсом (не включает изменения кода).

git commit -m ":lipstick: style: corrigir formatação do código"
♻️

refactor

Относится к изменениям в результате рефакторинга, которые не меняют функциональность, например, к повышению производительности благодаря проверке кода.

git commit -m ":recycle: refactor: otimizar algoritmo de busca"
⚡

perf

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

git commit -m ":zap: perf: melhorar tempo de carregamento"
🧪

test

Используется при внесении изменений в тесты, будь то создание, изменение или удаление модульных тестов (не включает изменения кода).

git commit -m ":test_tube: test: adicionar testes unitários"
🔨

build

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

git commit -m ":package: build: atualizar dependências"
🧱

ci

Указывает на изменения, связанные с непрерывной интеграцией.

git commit -m ":bricks: ci: configurar pipeline de deploy"
🔧

chore

Указывает обновления задач сборки, настроек администратора и пакетов (не включает изменения кода).

git commit -m ":wrench: chore: atualizar .gitignore"
🗃️

raw

Указывает на изменения, связанные с файлами конфигурации или необработанными данными.

git commit -m ":card_file_box: raw: dados brutos do projeto"
🧹

cleanup

Указывает на очистку кода, удаление ненужных комментариев и общую оптимизацию.

git commit -m ":broom: cleanup: remover código não utilizado"
🗑️

remove

Указывает на удаление файлов, функций или кода, которые больше не нужны.

git commit -m ":wastebasket: remove: deletar arquivos obsoletos"

Шаблоны эмодзи

Тип фиксацииЭмодзиКлючевое слово
Доступность♿:wheelchair:
Добавление теста✅:white_check_mark:
Обновление версии субмодуля⬆️:arrow_up:
Понижение версии подмодуля⬇️:arrow_down:
Добавление зависимости➕:heavy_plus_sign:
Изменения в проверке кода👌:ok_hand:
Анимации и переходы💫:dizzy:
Исправление ошибки🐛:bug:
Комментарии💡:bulb:
Первоначальная фиксация🎉:tada:
Настройки🔧:wrench:
Развертывать🚀:rocket:
Документация📚:books:
В ходе выполнения🚧:construction:
Стилизация пользовательского интерфейса💄:lipstick:
Инфраструктура🧱:bricks:
Список задач🔜:soon:
Переместить/переименовать🚚:truck:
Новый функционал✨:sparkles:
Package.json в JS📦:package:
Производительность⚡:zap:
Рефакторинг♻️:recycle:
Очистка кода🧹:broom:
Удаление файла🗑️:wastebasket:
Удаление зависимости➖:heavy_minus_sign:
Отзывчивость📱:iphone:
Откат изменений💥:boom:
Безопасность🔒:lock:
SEO🔍:mag:
Тег версии🔖:bookmark:
Пройти тест✔️:heavy_check_mark:
Тесты🧪:test_tube:
Текст📝:pencil:
Ввод текста🏷️:label:
Обработка ошибок🥅:goal_net:
Данные🗃️:card_file_box:

Основные команды Git

Репозиторий клонов

Клонирует существующий удаленный репозиторий GitHub в вашу локальную среду.

git clone url-do-repositorio-no-github

Инициализировать репозиторий

Инициализирует новый репозиторий Git в текущем каталоге.

git init

Добавить файлы

Добавляет все файлы и изменения в текущем каталоге в промежуточную область.

git add .

Сделать фиксацию

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

git commit -m "mensagem do commit"

Переименовать ветку

Переименовывает текущую ветку (master) в main. -M используется для принудительного переименования.

git branch -M main

Добавить удаленный репозиторий

Добавляет удаленный репозиторий с именем origin в локальный репозиторий.

git remote add origin https://github.com/usuario/nome-do-repositorio.git

Отправить в репозиторий

Отправляет коммиты из локальной ветки в удаленный репозиторий.

git push -u origin main

Обновление из репозитория

Обновляет локальную ветку изменениями из удаленного репозитория.

git pull origin main

Подключить локальный репозиторий

Если у вас уже есть локальный репозиторий и вы хотите подключить его к удаленному репозиторию на GitHub.

git remote add origin git@github.com:usuario/projeto.git
git branch -M main
git push -u origin main

Получить обновления

Получает все обновления из удаленного репозитория, не объединяя их с текущей веткой.

git fetch

Безопасный принудительный толчок

Более безопасный способ принудительной отправки локальных изменений в удаленный репозиторий.

git push --force-with-lease

Отменить фиксацию

Создает новый коммит, который отменяет изменения, внесенные указанным коммитом.

git revert id_do_commit_que_vai_ser_revertido

Сбросить фиксацию

Сбрасывает репозиторий в указанное состояние фиксации, удаляя все последующие изменения.

git reset --hard id_do_commit_anterior_ao_que_vai_ser_apagado

Изменить сообщение фиксации

Изменяет сообщение последнего коммита.

git commit --amend -m "mensagem_reescrita"

Черри Пик

Используется для получения определенного коммита из другой ветки.

git cherry-pick HASH_DO_COMMIT

Обмен филиала

Переключитесь на другую ветку локального репозитория.

git switch <branch>

Глоссарий

fork

Скопируйте репозиторий в свою учетную запись GitHub.

issues

Инструмент, используемый для управления задачами и исправления ошибок.

pull request

Механизм, используемый для отправки предлагаемых изменений в исходный репозиторий.

gist

Инструмент для обмена фрагментами кода.

💡Важные советы

  • ✓Используйте четкие, описательные сообщения, объясняющие, что было изменено.
  • ✓Делайте коммиты небольшими и сосредоточенными на одной функции.
  • ✓Используйте правильный тип фиксации, чтобы упростить навигацию по истории.
  • ✓Всегда проверяйте изменения перед их фиксацией.

Ссылки