Git bietet flexible Verzweigungsstrategien, aber was bedeutet das? In einfachen Worten, eine Verzweigungsstrategie ist eine Reihe von Regeln, eine Konvention, die Teams und Entwicklern hilft – sie können diese Regeln und Konventionen befolgen, um eine neue Verzweigung, ihren Ablauf usw. zu erstellen.
Die Nichtverwendung angemessener Namenskonventionen führt zu Verwirrung und verkompliziert das Codewartungsteam. Wir können die Best Practices von Git bei Namenskonventionen für Verzweigungen nicht ignorieren.
Git-Branching-Strategien ermöglichen die Trennung von Arbeit. Grob können wir Git-Branches in zwei Kategorien einteilen:Reguläre und temporäre Branches.
Reguläre Git-Zweige
Diese Branches werden dauerhaft in Ihrem Repository verfügbar sein. Ihre Namenskonvention ist einfach und unkompliziert.
- Entwicklung (dev ) ist der Hauptentwicklungszweig. Die Idee des Dev-Zweigs ist es, Änderungen daran vorzunehmen und die Entwickler daran zu hindern, Änderungen direkt im Master-Zweig vorzunehmen. Änderungen im Dev-Zweig werden überprüft und nach dem Testen mit dem Master-Zweig zusammengeführt.
- Meister (Meister ) ist der im Git-Repository verfügbare Standardzweig. Es sollte die ganze Zeit stabil sein und keinen direkten Check-in zulassen. Sie können es erst nach der Codeüberprüfung zusammenführen. Alle Teammitglieder sind dafür verantwortlich, den Master stabil und aktuell zu halten.
- QA (QA ) oder Testzweig enthält den gesamten Code für QA-Tests und Automatisierungstests aller implementierten Änderungen. Bevor eine Änderung in die Produktionsumgebung geht, muss sie den QA-Tests unterzogen werden, um eine stabile Codebasis zu erhalten.
Temporäre Git-Zweige
Wie der Name schon sagt, sind dies die Zweige, die bei Bedarf erstellt und gelöscht werden können. Sie können wie folgt aussehen:
- Fehlerbehebung
- Hotfix
- Funktionszweige
- Experimentelle Zweige
- WIP-Zweige
Es gibt viele Formate und Namenskonventionen, die von Experten für temporäre Niederlassungen empfohlen werden.
Hier ist ein einfacher Workflow von Git-Branches.
Git-Branching-Namenskonvention
In diesem Artikel werde ich die sieben besten Namenskonventionen, die ich persönlich in der Vergangenheit verwendet habe, überprüfen und teilen, um ihre Effizienz sicherzustellen.
1. Beginnen Sie den Zweignamen mit einem Gruppenwort
Es ist eine der besten Praktiken. Das Gruppenwort kann beliebig sein, um Ihrem Arbeitsablauf zu entsprechen.
Ich mag kurze Wörter wie die folgenden:
Fehler – Der Fehler, der bald behoben werden muss
WIP – Die Arbeit ist im Gange und ich bin mir bewusst, dass sie nicht bald abgeschlossen sein wird
Wenn Sie sich den Branch-Namen ansehen, können Sie verstehen, worum es bei diesem Git-Branch geht und welchen Zweck er hat.
Sehen Sie sich die folgenden Beispiele an:
- bug-logo-alignment-issue – der Entwickler versucht, das Problem mit der Logoausrichtung zu beheben;
- wip-ioc-container-added – der Zweig bezieht sich auf die Aufgabe, einen laufenden IoC-Container hinzuzufügen.
2. Verwenden Sie eindeutige IDs in Zweignamen
Sie können die Issue-Tracker-ID in Ihrem Zweigstellennamen verwenden. Ich bevorzuge diese Methode, wenn ich an der Behebung einiger Fehler arbeite. Zum Beispiel:
wip-8712-add-testing-module
Der Name zeigt, dass die Verzweigung für die Aufgabe gilt, ein Testmodul hinzuzufügen, die Tracking-ID des Problems ist 8712 und die Arbeit ist im Gange.
Ein weiterer Vorteil der Verwendung einer externen Tracking-ID im Filialnamen ist die Möglichkeit, den Fortschritt von einem externen System aus zu verfolgen.
3. Verwenden Sie Bindestrich oder Schrägstrich als Trennzeichen
Viele Entwickler verwenden Schrägstriche als Trennzeichen und viele verwenden Bindestriche. Welche Sie verwenden sollten – hängt von Ihnen und den Vorlieben Ihres Teams ab.
Meiner Meinung nach machen Bindestriche den Namen angenehmer zu lesen, daher ist es ein geeignetes Trennzeichen in Zweignamen. Sie können Schrägstriche, Bindestriche und Unterstriche verwenden. Der Punkt ist, konsequent zu sein.
Die Verwendung eines Trennzeichens im Zweignamen hat zwei Hauptvorteile:
- Es erhöht die Lesbarkeit und hilft, Verwirrung zu vermeiden;
- Es erleichtert die Verwaltung, insbesondere wenn Sie mit vielen Filialen zu tun haben.
Beispiel 1. Git-Branch-Name ohne Trennzeichen:
featureupgradejqueryversionloginmodul
Beispiel 2. Durch Hinzufügen eines Trennzeichens (in diesem Fall ein Unterstrich) machen Sie den Git-Branch-Namen lesbar:
feature_upgrade_jquery_version_login_module
4. Git-Zweig mit Autorenname
Viele Unternehmen ziehen es vor, die Namen der Autoren gemäß dem folgenden Format in die Branchennamen einzufügen:
<author>_<branch-type>_<branch-name>Beispiel:rajeev.bera_feature_new-experimental-changes
Diese Methode ermöglicht eine einfache Verfolgung der Arbeit und des Fortschritts verschiedener Entwickler mit zusätzlichen Systemen.
5. Vermeiden Sie die ausschließliche Verwendung von Zahlen
Einige Entwickler verwenden die Issue-ID nur im Branch-Namen, was für den Arbeitsfortschritt nicht hilfreich ist.
Zum Beispiel gibt es einen Filialnamen 9912 – was soll uns diese magische Zahl sagen? Es bedeutet nur mehr Verwirrung und das Risiko von Fehlern, insbesondere beim Zusammenführen mit anderen Git-Zweigen.
6. Vermeiden Sie es, alle Namenskonventionen gleichzeitig zu verwenden
Das Mischen und Abgleichen aller Benennungskonventionen für Git-Zweige ist nicht die beste Methode. Es fügt nur Verwirrung hinzu und verkompliziert die Gesamtprozesse.
Ein Team sollte die Namenskonventionen für die Arbeit einmal festlegen und sich daran halten. Konsistenz ist das Wichtigste.
7. Vermeiden Sie lange beschreibende Namen für langlebige Zweige
Die wesentliche Eigenschaft eines Branchennamens ist, dass er präzise und informativ ist. Schauen wir uns noch einmal einige Beispiele an:
wip_login_module_which_will_used_in_the_public_website
wip_login_module_which_will_used_in_the_internal_website
Dort sind die Filialnamen lang und detailliert. Es ist nicht notwendig. Stattdessen könnten Sie die folgende Variante verwenden:
wip_feature_login_module
Dieser Name ist kurz, aber er erklärt den Zweck dieses Zweigs.
Schlussfolgerung
Das Git-Branching-Modell ist leistungsfähig, aber Sie müssen die Branches korrekt und effektiv verwalten. Einer der notwendigen Faktoren ist, dass alle Teams denselben Konventionen folgen, insbesondere – den Namenskonventionen für das lokale Repository.
Um sicherzustellen, dass Ihr Team die vereinbarten Konventionen verwendet, setzen Sie die Standards durch. Eine der einfachsten Möglichkeiten ist die Verwendung von Git-Hooks wie dem Pre-Commit-Hook. Ich hoffe, es gibt Ihnen eine Vorstellung von den Git-Branching-Modellen und ihrer Namenskonvention.
