578 Stimmen

Gibt es eine Namenskonvention für Git-Repositories?

Ich habe zum Beispiel einen RESTful-Dienst namens Purchase Service. Soll ich mein Repository benennen:

  1. purchaserestservice
  2. purchase-rest-service
  3. purchase_rest_service
  4. oder etwas anderes?

Was ist die Konvention? Wie sieht es in GitHub aus? Sollten öffentliche Repositories einem Standard folgen?

676voto

Aaron Digulla Punkte 308693

Ich würde mich für purchase-rest-service . Gründe:

  1. What is "pur chase rests ervice"? Long, concatenated words are hard to understand. I know, I'm German. "Donaudampfschifffahrtskapitänspatentausfüllungsassistentenausschreibungsstellenbewerbung."

  2. "_" ist schwieriger zu tippen als "-".

163voto

Matthew Sandoz Punkte 1511

T

H

  1. u
  2. u
  3. b
  4. b

27voto

VonC Punkte 1117238

Ohne eine bestimmte Namenswahl zu bevorzugen, sollten Sie daran denken, dass ein Git-Repository in ein beliebiges Root-Verzeichnis Ihrer Wahl geklont werden kann:

git clone https://github.com/user/repo.git myDir

Hier repo.git würde in die myDir Verzeichnis.

Selbst wenn Ihre Namenskonvention für ein öffentliches Projektarchiv nicht ganz korrekt wäre, wäre es also immer noch möglich, dies auf der Client-Seite zu korrigieren.

Aus diesem Grund wird in einem verteilt Umgebung, in der jeder Client tun kann, was er/sie will, gibt es nicht wirklich eine Namenskonvention für Git Repo.
(außer zum Reservieren von " xxx.git " für nackt Form des Repo ' xxx ')
Es könnte eine Namenskonvention für REST-Dienste geben A "

7voto

Adam Punkte 20147

Wenn Sie vorhaben, ein PHP-Paket zu erstellen, wollen Sie es wahrscheinlich auf Packagist um sie für andere Komponisten verfügbar zu machen. Composer hat die Eigenschaft Namensgebungskonvention zu verwenden vendorname/package-name-is-lowercase-with-hyphens .

Wenn Sie planen, ein JS-Paket zu erstellen, möchten Sie wahrscheinlich npm verwenden. Eine ihrer Benennungskonventionen ist es, keine Großbuchstaben in der Mitte des Paketnamens zuzulassen.

Daher würde ich für PHP- und JS-Pakete empfehlen, die lowercase-with-hyphens und benennen Sie Ihre Pakete in composer oder npm identisch mit Ihrem Paket auf GitHub.

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X