Например, у меня есть служба RESTful, которая называется «Служба покупки». Должен ли я назвать свой репозиторий:
purchaserestservice
purchase-rest-service
purchase_rest_service
- или что-то другое?
Что такое конвенция? Как насчет Github? Должны ли публичные репозитории следовать каким-то стандартам?
git
github
naming-conventions
Адриан М
источник
источник
Ответы:
Я бы пошел на
purchase-rest-service
. Причины:Что такое "погоня за ошибками"? Длинные объединенные слова трудно понять. Я знаю, я немец. "Donaudampfschifffahrtskapitänspatentausfüllungsassistentenausschreibungsstellenbewerbung."
«_» труднее набрать, чем «-»
источник
Проблема с верблюжьим случаем заключается в том, что часто существуют разные толкования слов - например, checkinService против checkInService. Как и в случае с ответом Аарона, при автозаполнении трудно, если у вас есть много репо с одинаковыми именами, чтобы постоянно проверять, использовал ли человек, создавший репо, который вам нужен, определенную разбивку в верхнем и нижнем регистре. избегайте прописных букв
Его точка зрения о тире также хорошо рекомендуется.
источник
lowercase-with-hyphens
это стиль, который я чаще всего вижу на GitHub. *lowercase_with_underscores
вероятно, второй по популярности стиль, который я вижу.Первый мой выбор, потому что он экономит нажатия клавиш.
* Анекдотический; Я не собрал никаких данных.
источник
lowercase-with-hyphens
Не отдавая предпочтения какому-либо конкретному выбору имен, помните, что git-репо можно клонировать в любой корневой каталог по вашему выбору:
Вот
repo.git
бы клонировать вmyDir
каталог.Таким образом, даже если ваше соглашение об именах для публичного репо окажется слегка неправильным, все равно можно будет исправить его на стороне клиента.
Вот почему в распределенной среде, где любой клиент может делать все, что он / она хочет, в действительности нет соглашения об именовании для Git-репо.
(за исключением того, чтобы зарезервировать "
xxx.git
" для простой формы репозитория "xxx
).Возможно, существует соглашение об именовании для службы REST (аналогично" Существуют ли какие-либо рекомендации по соглашениям об именах для API REST? "), но это отдельная проблема.
источник
Может быть, это просто мой фон Java и C, но я предпочитаю CamelCase (CapCase), чем пунктуацию в названии. Моя рабочая группа использует такие имена, вероятно, для соответствия именам приложения или службы, которые содержатся в репозитории.
источник
Если вы планируете создать пакет PHP, вы, скорее всего, захотите добавить его в Packagist, чтобы сделать его доступным для других с помощью composer. Композитор имеет в качестве имен-конвенции к использованию
vendorname/package-name-is-lowercase-with-hyphens
.Если вы планируете создать пакет JS, вы, вероятно, захотите использовать npm. Одно из соглашений об именах - не допускать прописных букв в середине имени вашего пакета.
Поэтому я бы рекомендовал пакетам PHP и JS использовать
lowercase-with-hyphens
и называть ваши пакеты в composer или npm идентично вашему пакету на GitHub.источник