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

Question

Par exemple, j'ai un service RESTful appelé Service d'achat. 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 ? Et dans Github ? Les dépôts publics doivent-ils suivre une norme ?

Answer 1

Je choisirais purchase-rest-service . Raisons :

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

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

Answer 2

Le problème de la casse est qu'il y a souvent des interprétations différentes des mots - par exemple, checkinService vs checkInService. Pour aller dans le sens de la réponse d'Aaron, il est difficile avec l'autocomplétion si vous avez beaucoup de dépôts nommés de manière similaire de devoir constamment vérifier si la personne qui a créé le dépôt qui vous intéresse a utilisé une certaine répartition des majuscules et des minuscules. évitez les majuscules.

Sa remarque sur les tirets est également judicieuse.

1. utilisez les minuscules.
2. utiliser des tirets.
3. Soyez précis. Vous devrez peut-être différencier des idées similaires par la suite - par exemple, utilisez l'expression "achat-restauration" au lieu de "service" ou "restauration".
4. soyez cohérent. considérez l'utilisation des différents fournisseurs de GIT - comment voulez-vous que vos dépôts soient triés/groupés ?

Answer 3

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 vois.

Je préfère la première solution, car elle permet d'économiser les frappes au clavier.

* Anecdotique ; je n'ai pas recueilli de données.

Answer 4

Sans privilégier un choix de nom particulier, rappelez-vous qu'un dépôt git peut être cloné dans le répertoire racine de votre choix :

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

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

Ainsi, même si votre convention de dénomination pour un dépôt public s'avérait légèrement incorrecte, il serait toujours possible de la corriger du côté client.

C'est pourquoi, dans un distribué Dans un environnement où chaque client peut faire ce qu'il veut, il n'y a pas vraiment de convention de dénomination pour les dépôts Git.
(sauf pour réserver " xxx.git " pour nu de la forme du repo ' xxx ')
Il peut y avoir une convention de dénomination pour les services REST (similaire à " Existe-t-il des directives en matière de convention de dénomination pour les API REST ? "), mais il s'agit là d'une question distincte.

Answer 5

C'est peut-être mon expérience de Java et du langage C qui le montre, mais je préfère la majuscule à la ponctuation dans le nom. Mon groupe de travail utilise de tels noms, probablement pour correspondre aux noms de l'application ou du service que le référentiel contient.