web-dev-qa-db-fra.com

Existe-t-il une convention de nommage pour les dépôts git?

Par exemple, j'ai un service RESTful appelé Purchase Service. Dois-je nommer mon référentiel

  1. purchaserestservice
  2. purchase-rest-service
  3. purchase_rest_service
  4. ou autre chose?

Quelle est la convention? Que diriez-vous de github? Les pensions publiques devraient-elles suivre certaines normes?

gitgithubnaming-conventions
276
Adrian M

J'irais pour purchase-rest-service. Les raisons:

  1. Qu'est-ce que "pur chase repose ervice"? Les mots longs et concaténés sont difficiles à comprendre. Je sais, je suis allemand. "Donaudampfschifffahrtskapitänspatentausfüllungsassistentenausschreibungsstellenbewerbung."

  2. "_" est plus difficile à taper que "-"

313
Aaron Digulla

Le problème avec les cas de chameaux est qu’il existe souvent différentes interprétations des mots - par exemple, checkinService vs checkInService. Si l'on s'en tient à la réponse d'Aaron, il est difficile avec l'auto-complétion si vous avez plusieurs référents portant le même nom, qui doivent constamment vérifier si la personne qui a créé le repo qui vous tient à cœur a utilisé une certaine ventilation des majuscules et des minuscules. éviter les majuscules.

Son point sur les tirets est également judicieux.

  1. utilisez des minuscules.
  2. utilisez des tirets.
  3. être spécifique. vous constaterez peut-être que vous devrez ultérieurement faire la distinction entre des idées similaires, c’est-à-dire que vous utilisez un service d’achat-repos-service au lieu de service ou de service-repos.
  4. être cohérent. Pensez à l’utilisation des différents fournisseurs GIT - comment voulez-vous que vos référentiels soient triés/groupés?
58
Matthew Sandoz

lowercase-with-hyphens est le style que je vois le plus souvent sur GitHub. *

lowercase_with_underscores est probablement le deuxième style le plus populaire que je voie.

Le premier est ma préférence car il enregistre les frappes.

* Anecdotique; Je n'ai collecté aucune donnée.

40
Dennis

Sans privilégier aucun choix de nommage particulier, rappelez-vous qu'un git repo peut être cloné dans n'importe quel répertoire racine de votre choix:

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

Ici, repo.git serait cloné dans le répertoire myDir.

Ainsi, même si votre convention de dénomination pour un rapport public devenait légèrement incorrecte, il serait toujours possible de le corriger côté client.

C'est pourquoi, dans un environnement distribué où tout client peut faire ce qu'il veut, il n'y a pas vraiment de convention de dénomination pour le référentiel Git.
(sauf pour réserver "xxx.git" à la forme nue du repo 'xxx')
Il peut y avoir une convention de dénomination pour le service REST (semblable à " ) Existe-t-il des règles de convention de dénomination pour les API REST? "), mais il s’agit d’une question distincte.

18
VonC

C’est peut-être juste mon arrière-plan Java et C, mais je préfère CamelCase (CapCase) à la ponctuation dans le nom. Mon groupe de travail utilise de tels noms, probablement pour correspondre aux noms de l'application ou du service contenu dans le référentiel.

7
SteveW