Существует ли соглашение об именах для репозиториев git?

Например, у меня есть служба RESTful, называемая Purchase Service. Должен ли я назвать мой репозиторий

  • purchaserestservice
  • purchase-rest-service
  • purchase_rest_service
  • или что-то еще?

Какое соглашение? Как насчет в github? Должны ли публичные репозитории следовать стандарту?

ОТВЕТЫ

Ответ 1

Я бы пошел за purchase-rest-service. Причины:

  • Что такое "презерватив"? Длинные, конкатенированные слова трудно понять. Я знаю, я немец. "Donaudampfschifffahrtskapitänspatentausfüllungsassistentenausschreibungsstellenbewerbung."

  • "_" сложнее напечатать, чем "-"

Ответ 2

Проблема с корпусом верблюда заключается в том, что часто используются разные интерпретации слов - например, checkinService vs checkInService. Отвечая на вопросы Аарона, сложно с автозавершением, если у вас есть много аналогично названных репозиториев, которые должны постоянно проверять, был ли человек, создавший репо, который вас беспокоил, использовал определенную разбивку верхнего и нижнего регистра. избегать верхнего регистра.

Его точка в тире также хорошо информирована.

  • использование нижний чехол.
  • используйте тире.
  • быть конкретным. вы можете обнаружить, что вам придется дифференцировать подобные идеи позже, то есть использовать покупку-отдых-сервис вместо службы или службы отдыха.
  • быть последовательным. рассмотрите возможность использования различных поставщиков GIT - как вы хотите, чтобы ваши репозитории сортировались/группировались?

Ответ 3

lowercase-with-hyphens - это стиль, который я чаще всего вижу на GitHub. *

lowercase_with_underscores, вероятно, второй по популярности стиль, который я вижу.

Первое - это мое предпочтение, потому что оно экономит нажатия клавиш.

* Анекдотический; Я не собирал никаких данных.

Ответ 4

Не пользуясь каким-либо конкретным выбором именования, помните, что репозиторий git можно клонировать в любой корневой каталог по вашему выбору:

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

Здесь repo.git будет клонирован в каталог myDir.

Итак, даже если ваше соглашение об именах для публичного репо оказалось немного неправильным, все равно можно было бы исправить его на стороне клиента.

Вот почему в распределенной среде, где любой клиент может делать все, что захочет, наречия для git репо нет на самом деле. (за исключением резерва "xxx.git" для пустой формы репо 'xxx')
Возможно, существует соглашение об именах для службы REST (аналогично Существуют ли какие-либо правила для соглашений об именах для API REST?"), но это отдельная проблема.

Ответ 5

Может быть, это только мои иллюстрации на Java и C, но я предпочитаю CamelCase (CapCase) над пунктуацией в имени. Моя рабочая группа использует такие имена, возможно, чтобы соответствовать именам приложения или службы, содержащейся в репозитории.