Commit-Muster

Commit-Muster

Lernen Sie, semantische und professionelle Commits zu schreiben

Commit-Muster

Gemäß der Dokumentation zu konventionellen Commits handelt es sich bei semantischen Commits um eine einfache Konvention, die in Commit-Nachrichten verwendet wird. Diese Konvention definiert eine Reihe von Regeln zum Erstellen eines expliziten Commit-Verlaufs, der die Erstellung automatisierter Tools erleichtert. Mithilfe dieser Commits können Sie und Ihr Team leichter nachvollziehen, welche Änderungen an dem Code vorgenommen wurden, für den ein Commit durchgeführt wurde. Diese Identifizierung erfolgt über ein Wort und ein Emoji, die identifizieren, ob es sich bei dem festgeschriebenen Commit um eine Codeänderung, Paketaktualisierung, Dokumentation, visuelle Änderung, Test usw. handelt.

Arten von Commits

Semantische Commits verfügen über die folgenden Strukturelemente (Typen), die dem Benutzer Ihres Codes die Absicht Ihres Commits mitteilen.

✨

feat

Zeigt an, dass Ihr Code-Snippet eine neue Funktionalität enthält (im Zusammenhang mit MINOR in der semantischen Versionierung).

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

fix

Zeigt an, dass Ihr festgeschriebenes Code-Snippet ein Problem löst (Bugfix), es hängt mit PATCH in der semantischen Versionierung zusammen.

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

docs

Zeigt an, dass Änderungen an der Dokumentation vorgenommen wurden, beispielsweise in der README-Datei Ihres Repositorys (enthält keine Codeänderungen).

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

style

Zeigt an, dass Änderungen im Zusammenhang mit Codeformatierung, Semikolons, Leerzeichen und Flusen vorgenommen wurden (Codeänderungen sind nicht enthalten).

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

refactor

Bezieht sich auf Änderungen aufgrund von Refactoring, die die Funktionalität nicht verändern, z. B. Leistungsverbesserungen aufgrund von Codeüberprüfungen.

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

perf

Es dient dazu, etwaige leistungsrelevante Codeänderungen zu identifizieren.

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

test

Wird verwendet, wenn Änderungen an Tests vorgenommen werden, unabhängig davon, ob Komponententests erstellt, geändert oder gelöscht werden (umfasst keine Codeänderungen).

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

build

Wird verwendet, wenn Änderungen an Builddateien und Abhängigkeiten vorgenommen werden.

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

ci

Zeigt Änderungen im Zusammenhang mit der kontinuierlichen Integration an.

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

chore

Zeigt Aktualisierungen für Build-Aufgaben, Admin-Einstellungen und Pakete an (beinhaltet keine Codeänderungen).

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

raw

Zeigt Änderungen im Zusammenhang mit Konfigurationsdateien oder Rohdaten an.

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

cleanup

Zeigt Codebereinigung, Entfernung unnötiger Kommentare und allgemeine Optimierungen an.

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

remove

Zeigt die Entfernung von Dateien, Funktionen oder Code an, die nicht mehr benötigt werden.

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

Emoji-Muster

Commit-TypEmojiStichwort
Zugänglichkeit♿:wheelchair:
Einen Test hinzufügen✅:white_check_mark:
Submodulversion wird aktualisiert⬆️:arrow_up:
Submodulversion wird herabgestuft⬇️:arrow_down:
Abhängigkeit hinzufügen➕:heavy_plus_sign:
Änderungen bei der Codeüberprüfung👌:ok_hand:
Animationen und Übergänge💫:dizzy:
Fehlerbehebung🐛:bug:
Kommentare💡:bulb:
Erster Commit🎉:tada:
Einstellungen🔧:wrench:
Einsetzen🚀:rocket:
Dokumentation📚:books:
Im Gange🚧:construction:
UI-Styling💄:lipstick:
Infrastruktur🧱:bricks:
Aufgabenliste🔜:soon:
Verschieben/Umbenennen🚚:truck:
Neue Funktionalität✨:sparkles:
Package.json in JS📦:package:
Leistung⚡:zap:
Refactoring♻️:recycle:
Codebereinigung🧹:broom:
Eine Datei entfernen🗑️:wastebasket:
Entfernen einer Abhängigkeit➖:heavy_minus_sign:
Reaktionsfähigkeit📱:iphone:
Änderungen rückgängig machen💥:boom:
Sicherheit🔒:lock:
SEO🔍:mag:
Versions-Tag🔖:bookmark:
Test bestehen✔️:heavy_check_mark:
Tests🧪:test_tube:
Text📝:pencil:
Tippen🏷️:label:
Fehlerbehandlung🥅:goal_net:
Daten🗃️:card_file_box:

Haupt-Git-Befehle

Klon-Repository

Klont ein vorhandenes Remote-GitHub-Repository in Ihre lokale Umgebung.

git clone url-do-repositorio-no-github

Repository initialisieren

Initialisiert ein neues Git-Repository im aktuellen Verzeichnis.

git init

Dateien hinzufügen

Fügt alle Dateien und Änderungen im aktuellen Verzeichnis zum Staging-Bereich hinzu.

git add .

Machen Sie Commit

Zeichnet Änderungen, die dem Staging-Bereich hinzugefügt wurden, mit einer beschreibenden Meldung auf.

git commit -m "mensagem do commit"

Zweig umbenennen

Benennt den aktuellen Zweig (Master) in Main um. -M wird verwendet, um eine Umbenennung zu erzwingen.

git branch -M main

Remote-Repository hinzufügen

Fügt dem lokalen Repository ein Remote-Repository namens „Origin“ hinzu.

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

An Repository senden

Sendet Commits vom lokalen Zweig an das Remote-Repository.

git push -u origin main

Update aus dem Repository

Aktualisiert den lokalen Zweig mit Änderungen aus dem Remote-Repository.

git pull origin main

Lokales Repository verbinden

Wenn Sie bereits über ein lokales Repository verfügen und es mit einem Remote-Repository auf GitHub verbinden möchten.

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

Updates abrufen

Ruft alle Aktualisierungen aus dem Remote-Repository ab, ohne sie im aktuellen Zweig zusammenzuführen.

git fetch

Sicherer erzwungener Push

Sicherere Möglichkeit, die Übertragung lokaler Änderungen in das Remote-Repository zu erzwingen.

git push --force-with-lease

Commit zurücksetzen

Erstellt einen neuen Commit, der die durch den angegebenen Commit vorgenommenen Änderungen rückgängig macht.

git revert id_do_commit_que_vai_ser_revertido

Commit zurücksetzen

Setzt das Repository auf den angegebenen Commit-Status zurück und löscht alle nachfolgenden Änderungen.

git reset --hard id_do_commit_anterior_ao_que_vai_ser_apagado

Commit-Nachricht ändern

Ändert die Nachricht des letzten Commits.

git commit --amend -m "mensagem_reescrita"

Kirschpflücker

Wird verwendet, um einen bestimmten Commit aus einem anderen Zweig abzurufen.

git cherry-pick HASH_DO_COMMIT

Filiale tauschen

Wechseln Sie zu einem anderen Zweig im lokalen Repository.

git switch <branch>

Glossar

fork

Kopieren Sie ein Repository in Ihr eigenes GitHub-Konto.

issues

Tool zum Verwalten von Aufgaben und Fehlerbehebungen.

pull request

Mechanismus zur Übermittlung vorgeschlagener Änderungen an das ursprüngliche Repository.

gist

Tool zum Teilen von Codeschnipseln.

💡Wichtige Tipps

  • ✓Verwenden Sie klare, beschreibende Nachrichten, die erklären, was geändert wurde
  • ✓Halten Sie die Commits klein und konzentrieren Sie sich auf eine einzelne Funktion
  • ✓Verwenden Sie den richtigen Commit-Typ, um die Navigation im Verlauf zu vereinfachen
  • ✓Testen Sie Ihre Änderungen immer, bevor Sie sie festschreiben

Referenzen