Git-Repository-Namen

Abdul Jabbar 20 Juni 2023
  1. Regeln für die Benennung von Repositories in Git
  2. Beispiel für einen Git-Repository-Namen
  3. Abschluss
Git-Repository-Namen

In unserem Alltag ist es von Bedeutung, jemanden zum Zeitpunkt der Interaktion beim Namen zu nennen. Schließlich ist ihr Name vor allem mit ihrer Identität verknüpft, was der einfachste Weg ist, jemandes Aufmerksamkeit zu erregen.

Und vor allem muss der Name prägnant sein, damit andere kein Problem damit haben, ihren Namen zu nennen oder zu verwenden.

Dasselbe ist bei Git der Fall. Die Benennung von Git-Repositories sollte konsistent und kompatibel sein, damit Benutzer Ihres Git-Kontos einfach und problemlos auf das gewünschte Repository zugreifen können, wodurch Ihre Arbeit mit diesen Namen authentischer und professioneller wird.

Wie jemand für Git-Repositorys sagte: Großartige Repository-Namen sind kurz und einprägsam.

Regeln für die Benennung von Repositories in Git

Die Wahl eines prägnanten und aktuellen Repository-Namens ist eine große Aufgabe bei der Verwendung von Git. Bei der Benennung eines Repositorys in Git sollten zwei Regeln beachtet werden.

  1. Der Repository-Name sollte gemäß Ihrem Konto eindeutig sein.

    Das bedeutet, dass sich Ihr Repository-Name von dem Ihres Teamkollegen unterscheiden sollte. Zum Beispiel, wenn Ihr Repo-Name my-best-repo ist und Ihr Teamkollege auch ein Repo namens my-best-repo hatte.

    Dies ist nicht möglich, da es bei der Verwendung von Git unmöglich ist, zwei Repositories mit demselben Namen unter einem Konto zu haben.

    Das bedeutet, dass jemand anderes auf GitHub ein Repository mit dem Namen my-awesome-repo haben kann, und Sie können auch eines haben. Sie können jedoch nicht zwei Repositories mit demselben Namen unter Ihrem Konto haben.

  1. Wählen Sie einen prägnanten und kompatiblen Namen, der Ihr Projekt widerspiegelt.

    Die Leute benennen ihre Repositories nach ihren Vorlieben; Einige bevorzugen Bindestriche -, um Wörter zu trennen, während andere Unterstriche _ verwenden.

    Dies hängt alles von den persönlichen Vorlieben ab, jedes Zeichen außer Leerzeichen und Tabulator könnte die Trennung vornehmen. Man sollte auch die Namensumwandlungen gemäß den Vorlieben und Regeln des Teams befolgen.

Beispiel für einen Git-Repository-Namen

Nach den oben gegebenen Vorschlägen werden wir uns ansehen, wie unser Repository aussehen sollte. Wir werden unseren Repo-Namen in drei Abschnitte unterteilen, die durch Bindestriche getrennt sind.

section1-section2-section3
  1. Abschnitt 1 definiert den Projektnamen, an dem wir als Team arbeiten.
  2. Abschnitt 2 definiert den Zweck des Projekts und die Projektdefinition.
  3. Abschnitt 3 definiert die Sprache oder den Rahmen des Projekts.

Dies könnte wie folgt aussehen.

Air-SoapAPI-CSharp

Die oben genannten Abschnitte können weiter durch Bindestriche getrennt werden, wenn wir sie aufteilen möchten, beispielsweise wenn wir Abschnitt 2 aus dem obigen Beispiel Soap-API trennen.

Abschluss

In diesem Artikel haben wir die Kriterien für einen Repository-Namen in Git zusammengefasst, darunter:

  1. Beschreibend
  2. Konsequent
  3. Kurz (kurz/prägnant)
  4. Zukunftsfreundlich
  5. Erweiterbar
  6. Wiederverwendbar
  7. Kontextbezogen
  8. Lesbar
Abdul Jabbar avatar Abdul Jabbar avatar

Abdul is a software engineer with an architect background and a passion for full-stack web development with eight years of professional experience in analysis, design, development, implementation, performance tuning, and implementation of business applications.

LinkedIn

Verwandter Artikel - Git Repository