Die besten Methoden zum Schreiben von Git Commit-Nachrichten: Genau wie die Profis

Wenn ein Entwickler in der Zeit zurückgeht, um etwas zu finden, woran er vor sechs Monaten gearbeitet hat, versteht er oft nicht, warum er diesen bestimmten Einsatz gemacht hat, und der einzige Grund dafür ist, dass er nicht die richtige Art und Weise befolgt hat, die Einsatznachricht zu schreiben.

\ Es gibt Standards für Einsatznachrichten, die Entwickler weltweit praktizieren, und es ist gut, beliebten Standards zu folgen, damit, wenn Sie nach einer längeren Zeit zurückkommen oder jemand anderes Ihre Einsatznachrichten ansieht, diese nicht peinlich wirken!

\

\ Teams sollten zuerst eine Konvention für Einsatznachrichten festlegen, die die Versionskontrollhistorie des Produkts, das sie entwickeln, spezifiziert.

\ Eine großartige Git-Einsatznachricht sollte einen angemessenen Stil, Inhalt und Metadaten haben.

\ Ein bekannter Git-Einsatz folgt dieser Konvention:

<type>(<scope>): <message>

\ <type> kann eines der folgenden sein:

• feat für eine neue Funktion.
• refactor für die Umstrukturierung von Produktionscode, z.B. Umbenennen einer Funktion.
• docs für Änderungen an der Dokumentation.
• fix für eine Fehlerbehebung für den Benutzer.
• perf für Leistungsverbesserungen.
• style für Formatierungsänderungen, fehlende Semikolons usw.
• test für das Hinzufügen fehlender Tests, Umstrukturierung von Tests.
• build für die Aktualisierung der Build-Konfiguration, Entwicklungstools oder andere für den Benutzer irrelevante Änderungen.

\ Sie können auch Ihren eigenen benutzerdefinierten Typ hinzufügen, je nach den Standards, denen Ihr Team folgt. Die oben genannten Standards werden vom ESLint-Team befolgt. Sie können ihre Einsatznachrichten hier überprüfen.

\ Der Bereich ist optional, und der Nachrichtenteil sollte eine einzeilige Aussage enthalten, nicht mehr als 72 Zeichen, um zusammenzufassen, wofür der Einsatz gedacht ist.

\ Viele Entwickler verwenden die Nachricht auch als Betreffzeile und fügen einen Textkörper hinzu; das ist im Grunde die Beschreibung des Einsatzes, aber eine einzeilige Einsatznachricht ist vorzuziehen, solange Sie den Kontext verstehen können (was und warum des Einsatzes). Wenn der Einsatz eine detailliertere Beschreibung erfordert, die nicht in einer einzigen Zeile erklärt werden kann, ist ein Einsatztextkörper immer notwendig.

\ Sie können auch Tools wie Glitter oder Commitizen verwenden, um Ihre Einsatznachrichten zu standardisieren.

\ Nicht nur das, Sie fragen sich vielleicht auch, ob es ein Tool gibt, das Ihre Einsatznachricht überprüft und einen Fehler anzeigt, wenn sie nicht den Richtlinien entspricht. Commit lint ist eines davon. Es hilft Ihrem Team, sich an eine Einsatzkonvention zu halten.

\ Oft verwenden Branchenexperten ihr JIRA- oder Click Up-Ticket als Einsatznachricht, damit alles jederzeit verknüpft oder zurückverfolgt werden kann und die Codebasis für zukünftige Entwickler wartbar bleibt.

\ Einige Teams fügen ihren Einsatznachrichten auch gerne Emojis hinzu. Ich habe eine Liste von Emojis und ihren jeweiligen Bedeutungen zusammengestellt. Sie können sie hier einsehen.

\ Am Ende ist das Wichtigste, dass Ihre Einsatznachricht aussagekräftig ist und Ihre Mitentwickler oder zukünftige Entwickler nicht darüber verwirrt, worum es bei einer bestimmten Änderung geht.

\ Wenn Sie mehr über konventionelle Einsätze, semantische Einsätze oder die Praktiken, die die Branche befolgt, erfahren möchten, hier sind einige Ressourcen für Sie:

1. Conventional Commits
2. Semantic Commits
3. How to write a commit message by CBeams

\