Triangle-Commits
Ein Betreff sieht so aus:
<Bereich><Verhalten oder Absicht>[Modifikator] <Ticket> (<Bereichsname>): <Zusammenfassung>
🧩👔 #412 (server): Einspruch innerhalb von 30 Tagen nach Ablehnung zulassen
🎨💄 — (tokens): Die neuen Farbtöne aus Figma übernehmen
Die Emojis sind die ersten Zeichen der Zeile, ohne Leerzeichen davor oder danach. Das letzte Beispiel ist ein Commit, der von einem Job erstellt wurde: Er hat kein Ticket, daher führt er einen Gedankenstrich (em dash).
Das Vokabular ist bewusst groß, und Sie müssen es nicht im Kopf behalten. Der Befehl gitmoji gibt es in kleine Teile ausgegeben. Lesen Sie nur das Stück, das Sie brauchen.
Der Befehl
Verwenden Sie den Befehl gitmoji. Wenn er nicht im PATH ist, lesen Sie references/vocabulary.txt im Ordner dieses Skills für das gesamte Vokabular und teilen Sie der Person mit, dass der Befehl fehlt.
| Wenn | Ausführen |
|---|---|
| Sie die Liste der Bereiche benötigen | gitmoji guide areas |
| Sie den Bereich kennen | gitmoji guide 🧩 (ein beliebiges Bereichs-Emoji oder -Name) |
| Nichts in der Bereichsanleitung passt | gitmoji guide groups, dann eine Gruppe: gitmoji guide "repair" |
| Zwei Einträge scheinen beide zu passen | gitmoji guide 🛡️, oder die Gruppe: gitmoji guide "protection" |
| Die Arbeit ist ein Versuch, eine Übergangslösung oder bahnbrechend | gitmoji guide modifiers |
| Sie die Bereichsnamen benötigen | gitmoji guide scopes |
| Sie im Begriff sind, die Zusammenfassung oder den Nachrichtentext zu schreiben | gitmoji guide message |
Vor git commit | gitmoji staged, dann gitmoji check -m '<subject>' für die erste Zeile, oder gitmoji check <file> für eine gesamte Nachricht |
Sie haben Shortcodes wie :jigsaw::necktie: eingegeben | Nichts: der Hook schreibt die Emojis für Sie |
| Sie machen einen Commit rückgängig | git revert <commit>; die eigene erste Zeile von Git bleibt wie sie ist |
| Der Hook hat einen Betreff abgelehnt | Lesen Sie seine Nachricht; sie nennt die Behebung |
| Sie möchten die Commits Ihres Branches überprüfen, bevor er landen kann | gitmoji history trunk..HEAD (der Branch, auf dem er landen wird, dann Ihrer) |
| Der Hook sagt, das Repository habe eine andere Version übernommen | Lesen Sie, was sich unter der von ihm angegebenen Adresse geändert hat, und informieren Sie den Benutzer, bevor Sie die Einstellungen ändern |
Bevor Sie Code schreiben: Planen Sie die Commits
Lesen Sie das Ticket und schreiben Sie die Betreffzeilen, die Sie voraussichtlich erstellen werden, als Liste. Jede einzelne ist eine Entscheidung, die ein Prüfer allein akzeptieren könnte, und jede einzelne ist etwas, das das Ticket verlangt. Der Bereich jeder Commit ist das Paket, das die Entscheidung besitzt (gitmoji guide scopes).
Dies sind Aufforderungen, kein Stapel, der gefüllt werden muss. Planen Sie einen Commit nur dort, wo das Ticket der Frage eine Antwort gibt:
- Was entscheidet das Geschäft (
👔), und was passiert im Laufe der Zeit (⛓️)? - Was wird abgelehnt, bevor ein Schritt versucht wird (
🛡️)? Wenn ein Schritt fehlschlägt, wie erholt er sich, welchen Fehlercode meldet er, und was wird den Leuten mitgeteilt (🥅)? - Welche Form ist zwischen den Teilen vereinbart (
🏷️), und was wird gespeichert (💾)? - Was sehen und tun die Benutzer, und mit welchem Commit erhalten sie es zum ersten Mal (
✨)? - Wie werden wir wissen, dass ein Benutzer es auf dem echten Produkt durchläuft (
✅, eigener Commit, hinzugefügt, sobald das Produkt auf diese Weise ausgeführt werden kann)?
Wenn der Ablauf noch nicht ausgeführt werden kann, liefern Sie die Funktion aus und vermerken Sie auf dem Ticket, dass die ✅ noch aussteht. Setzen Sie ✅ nicht auf eine kleinere Prüfung, um die Lücke zu füllen; das ist ☑️.
Prüfen Sie vor der Planung eines neuen Endpunkts, Speichers oder einer Richtlinie auf einen vorhandenen Eigentümer. Wenn eine Produktentscheidung fehlt und ändern würde, was ausgeliefert wird, schreiben Sie die Frage auf und fragen Sie. Klären Sie es nicht innerhalb eines Commits.
Eine Funktion, die eine einzige Entscheidung ist, mit ihrem einzigen Aufrufer und den erforderlichen Prüfungen, ist ein Commit. Planen Sie nur dann mehr Zeilen, wenn das Ticket mehr als eine Entscheidung enthält, die ein Prüfer separat treffen könnte. Eine Zeile, die das Ticket nie verlangt hat, ist zu feingranular.
Vor jedem Commit: Vier Fragen
- Zu welchem Bereich gehört die Änderung, oder worum geht es? Ein Test, ein Dokument und ein Spielplatz übernehmen den Bereich der Sache, um die es sich dreht.
- Was ist jetzt anders, oder was haben Sie getan? Wenn der Commit ändert, was versprochen wird, nennen Sie das Verhalten (ein Nomen). Nennen Sie andernfalls die Absicht (ein Verb).
- Ist die Arbeit nicht abgeschlossen? Nur dann fügen Sie ein drittes Emoji hinzu:
🧪ein Versuch,🚧eine Übergangslösung,💥Verbraucher müssen sich anpassen. Ein Versuch behält🧪bei jedem Commit, bis🏁(behalten) oder⚰️(verworfen), und nichts Abgeschlossenes darf davor davon abhängen. In die von einem Ticket gewählte Richtung zu bauen, ist kein Versuch. - Welches Ticket? Verwenden Sie das Ticketformat des Repositories. Nur ein Job schreibt
—.
Führen Sie dann gitmoji check -m '<subject>' aus.
Bevor Sie Änderungen bereitstellen, lesen Sie die Änderung als jemand, der nicht dabei war. Wo der Grund nicht aus dem Code ersichtlich ist, schreiben Sie einen Kommentar neben den Code: warum er so ist, wie er ist, was nicht geändert werden darf, woher ein Wert stammt. Sagen Sie warum, nicht was die Zeile tut. Ein Kommentar kostet Sie fast nichts und erspart dem nächsten Leser, ob Person, Junior oder Agent ohne Ihren Kontext, das Rätselraten.
Wenn ein Paar nicht passt
Das ist das Signal, noch einmal hinzuschauen, nicht das nächstbeste Etikett auszuwählen.
- Wenn zwei Etiketten passen, nennen Sie, was der Prüfer jetzt akzeptieren und was er zurückstellen könnte. Trennen Sie auf, wenn sich diese beiden Entscheidungen unterscheiden können und das Behaltene immer noch für sich allein funktioniert. Stellen Sie nach Pfad oder Hunk bereit (
git add -p). - Behalten Sie den einzigen Aufrufer, seine Verdrahtung und die erforderlichen Ablehnungsprüfungen zusammen, wenn keine von ihnen ein eigenes Versprechen hat. Markieren Sie den Commit mit seinem Punkt; der Rest reist mit.
gitmoji stagedmeldet zwei Bereiche: Stellen Sie dieselbe Frage. Wenn die Änderung nur als Ganzes sinnvoll ist, wie z. B. eine Form, die in zwei Sprachen gespiegelt wird, behalten Sie sie zusammen und nennen Sie das Paket, das die Entscheidung besitzt.- Teile, die durch die Hauptänderung erzwungen werden, reisen mit: ihre Typen, ihr Test, eine Story, eine Lockdatei.
Jeder Commit muss für sich allein bauen und bestehen. Wenn eine Aufteilung das brechen würde, behalten Sie die erzwungenen Teile zusammen und sagen Sie dies im Nachrichtentext.
Schreiben
- Zusammenfassung: Was das System jetzt tut, in den Worten der Domäne, beginnend mit einem Verb in Kleinbuchstaben. Die gesamte erste Zeile passt in 140 Zeichen, einschließlich Emojis, Ticket und Bereich, und kürzer ist besser;
gitmoji check -m '<subject>'zählt es für Sie, bevor Sie committen. Keine Dateinamen, keine Ticketnummern, kein "Wie". - Beschreibung: Jeder Commit, den Sie schreiben, hat eine, und der Hook lehnt einen Commit ohne sie ab. Nur ein Marker (
🔖,🔺), ein Commit, der von einem Job erstellt wurde, und eine von Git geschriebene Nachricht benötigen keine. Darunter eine leere Zeile, dann warum die Änderung vorgenommen wurde: der Grund, warum auf diese Weise und nicht auf die offensichtliche, oder der Wert, den Sie gewählt haben. Ein bis zwei Zeilen sind normalerweise genug; sechs sind das Maximum. Halten Sie Ticketverweise innerhalb des Satzes (z. B. "Siehe #42 für die Entscheidung"). Git kann eine Zeile entfernen, die mit#42beginnt, wenn jemand den Commit bearbeitet. Erzählen Sie nicht den Diff neu, listen Sie keine Dateien auf oder beschreiben Sie Ihren Prozess. - Emojis, keine Shortcodes. Nur die Zeichen werden committet.
Wer hat es geschrieben
Fügen Sie sich niemals selbst als Autor oder Co-Autor hinzu. Keine Co-Authored-By:-Zeile, keine Agentenidentität in git config user.* oder --author. Der Autor ist die verantwortliche Person, und der Hook lehnt einen Agenten dort ab. Einige Tools fügen ohne Aufforderung eine Co-Autor-Zeile für sich selbst hinzu; wenn der Hook einen Commit deswegen ablehnt, entfernen Sie die Zeile und committen Sie erneut.
Beenden Sie stattdessen den Nachrichtentext mit einer leeren Zeile und einer Signatur, die angibt, was in den Commit eingeflossen ist:
_
Beispiel-Modell (hoch), Redakteur
Claude Code (Beispiel-Sitzung)
Unter-Agenten: 2 × Beispiel-Helfer (mittel)
Team: Prüfer, Tester
Recherche: 3 Suchanfragen, 12 Seiten
Die ersten drei Zeilen sind immer vorhanden. Die letzten drei erscheinen nur, wenn sie zutreffen.
Wenn der Commit erstellt wird, ersetzt der Hook den Unterstrich durch △ und, zwischen Backticks, die Version des Vokabulars, gegen das die Nachricht geprüft wurde, sodass eine gespeicherte Signatur so aussieht:
△ `1.2.3`
Beispiel-Modell (hoch), Redakteur
Claude Code (Beispiel-Sitzung)
Schreiben Sie den Unterstrich; schreiben Sie niemals die △-Zeile selbst. Der Hook schließt jede Nachricht damit ab, auch die einer Person, die dann diese eine Zeile und keine Signatur enthält. gitmoji history liest sie, um mitzuteilen, welche Commits auf welcher Version sind.
Projekte können signature = "agents" unter [rules] setzen, um die Modell- und Harness-Zeilen zu verlangen, wenn eine unterstützte Agentensitzung den Commit-Hook ausführt. Ein Mensch kann mit der gewöhnlichen Beschreibung committen. Release-Marker und von Git generierte Nachrichten behalten ihre bestehenden Ausnahmen.
| Zeile | Was sie sagt |
|---|---|
_ | Die Signatur beginnt hier. Der Hook wandelt sie in △ `<Version>` um. |
| Modell-Zeile | Das Modell und sein Aufwand. Nach einem Komma Ihr Name, nur wenn Ihnen eine Person einen gegeben hat. |
| Harness-Zeile | Der Harness und, in Klammern, die Sitzungs-ID, falls vorhanden. |
Unter-Agenten: | Wie viele Unter-Agenten haben einen Teil der Arbeit dieses Commits erledigt, nach Modell und Aufwand. |
Team: | Die anderen Agenten, mit denen Sie für diesen Commit Nachrichten ausgetauscht haben. |
Recherche: | Websuchen, gelesene Seiten und Dokumentationsabfragen für diesen Commit. |
Schreiben Sie nichts davon aus dem Gedächtnis. Führen Sie das Skript für Ihren Harness in scripts/ im Ordner dieses Skills aus und fügen Sie das, was es ausgibt, ein. Der Pfad ist relativ zu dem Ordner, in dem sich diese Datei befindet, wo auch immer der Skill installiert ist:
python3 scripts/claude-code.py
In Claude Code ist dieser Ordner ${CLAUDE_SKILL_DIR}. Das Skript liest die eigene Aufzeichnung der Sitzung des Harness. Wenn Ihr Harness dort kein Skript hat, sagt scripts/README.md, wie Sie eines einmal ausarbeiten und hinzufügen können. Wo keine Aufzeichnung gefunden werden kann, gibt das Skript unknown aus. Ein Repository kann Sie bitten, eine Zeile wegzulassen, wie z. B. die Sitzungs-ID; seine eigenen Anweisungen sagen dies.
Wenn die Sitzung mehrere Aufgaben oder Repositories umfasst, überprüfen Sie die optionalen Aktivitätszeilen in Bezug auf diesen Commit. Behalten Sie nur die Beiträge, die Sie ihm zuordnen können.
Zeilen, die der Nachrichtentext enthalten kann
🩹benötigtEinschränkung: <was die Abhängigkeit nicht kann>.📥benötigtQuelle: <der Lauf, das Tool oder System, von dem es kam>.🏁und⚰️geben an, was die Entscheidung getroffen hat.🐛kann die Ursache nennen:Broken-by: <sha>.
Beim Upgrade von Gitmoji
Die CLI, der Skill und das Vokabular teilen sich eine Release-Nummer. Der Hook warnt, wenn die Einstellungen des Repositorys eine andere Version nennen als die, die der Befehl spricht. Informieren Sie den Benutzer und lesen Sie, was sich unter der Adresse geändert hat, die die Warnung angibt. Wenn der Benutzer die neue Version wünscht, setzen Sie sie unter [vocabulary] in den Einstellungen und committen Sie diese allein, mit der Version zwischen Backticks:
🔺 gitmoji `<Version>`: <was sich für dieses Repository ändert>
Schreiben Sie keine bereits geteilte Historie um, es sei denn, der Benutzer verlangt es: Commits, die unter früheren Regeln erstellt wurden, können so bleiben, wie sie sind. gitmoji history --unmigrated zeigt, welche davon heute nicht bestehen würden. Führen Sie gitmoji init aus, nachdem Sie die Sperre geändert haben, um den installierten Skill und die verwalteten Workflows zu aktualisieren.
Übernehmen von Pull-Requests und Upgraden der Historie
Aktivieren Sie den PR-Titel-Workflow und wählen Sie Pull-Request-Titel und Beschreibung als Standard-Merge-Nachricht. Schreiben Sie den menschlichen Titel. Gitmoji pflegt sein Emoji-Präfix, wenn sich die Commits ändern. Verwenden Sie Create a merge commit mit der vorgeschlagenen Nachricht. GitHub bewahrt die verfassten Commits auf und hängt die integrierende PR-Nummer an.
Für eine vorhandene Historie verwenden Sie die Upgrade-Anleitung und das installierte scripts/gitmoji-upgrade-history.py. Überprüfen Sie den Probelauf, bevor Sie einen lokalen Kandidaten erstellen. Links erfordern einen Nachweis, welcher PR gelandet ist. Ein Ersatz eines gemeinsam genutzten Branches ist eine separate Entscheidung für die Repository-Eigentümer.
Von Git geschriebene Nachrichten
Ein Merge kann jeden Titel haben. Der Hook bewahrt die Nachrichtendatei von Git während eines ausstehenden Merges auf, und gitmoji history erkennt einen gespeicherten Merge an seinen mehreren Eltern. Ein reiner Text-check -m hat nur den Betreff zur Verfügung. Es erkennt die üblichen Git-Branch-, Tag- und Commit-Merge-Überschriften, GitHub-Pull-Request-Merge-Überschriften, nummerierte Merge #N-Beschriftungen, zitierte Git-Revert- und Reapply-Betreffe, nummerierte Revert #N- und Reapply #N-Beschriftungen mit einem Titel, die standardmäßige Squash-Log-Überschrift von Git und die Autosquash-Präfixe fixup! , squash! und amend! .
Ein Squash-Merge mit einem benutzerdefinierten PR-Titel erzeugt einen gewöhnlichen Commit mit einem Elternteil. Cherry-Picks und Rebases können ebenfalls gewöhnliche Betreffe nach vorne tragen. Überprüfen Sie diese wie andere verfasste Commits. Eine PR-Nummer allein identifiziert keinen Merge.
Während der Einführung kann ein Projekt [rules] → untagged = "warn" in gitmoji.toml setzen, um einfache Betreffe zu akzeptieren und sie zur Überprüfung zu kennzeichnen. Der Standardwert ist "error". Mit "off" wird das fehlende Etikett still akzeptiert. Andere Prüfungen gelten weiterhin. Verwenden Sie gitmoji history trunk..HEAD auf Ihrem Branch, um Betreffe zu finden, die vor dem Teilen neu formuliert werden müssen. Die Historie überprüft unmarkierte Betreffe immer streng.
Wenn nichts passt
Biegen Sie keinen Eintrag zurecht. Verwenden Sie den nächstgelegenen ehrlichen, fügen Sie eine Nachrichtentextzeile Miss: <what you wanted to say> hinzu und informieren Sie den Benutzer. Fehlschläge (Misses) sind, wie das Vokabular korrigiert wird.