Подтвердить что ты не робот

Предлагается ли иметь имена репозитория Git в верхнем или верблюжьем корпусе вместо нижнего регистра?

Я вижу много проектов, содержащих имена нижних регистров для своих репозиториев GitHub.

Предлагается ли иметь имена репозитория в верхнем случае или случае верблюда?
Если (да/нет), почему?

4b9b3361

Ответ 1

Короткий ответ

Как показано в этой короткой статье, хорошее соглашение об именах будет:

  • используйте строчные буквы;
  • отдельное слово с дефисами.

Длинный ответ

Насколько я знаю, стандартного соглашения о регистре букв для именования репозиториев Git не существует.

В то время как другие VCS могут требовать имена репозитория в нижнем регистре, Git этого не делает. Таким образом, вы можете присвоить своему хранилищу то же имя, что и у вашего проекта/продукта (исключая пробелы и акценты или любые другие зависящие от системы текстовые представления).

Для репозиториев с несколькими словами предпочитайте дефисы - подчеркивать _ как это делают инженеры GitHub, хотя это может быть наследством со времен, когда GitHub еще не мог обрабатывать прописные буквы. Конечно, вы также можете использовать PascalCase или camelCase.

Затем, хорошая причина придерживаться строчных букв - это то, что имена репозиториев часто встречаются в URL, которые могут быть нечувствительными к регистру или даже преобразованы в строчные (это случалось с пользователями GitLab или Jira, например, в прошлом). По своему опыту я никогда не сталкивался с такими ограничениями, поэтому я доволен, когда названия моих продуктов начинаются с заглавной буквы.

Ответ 2

Предпочитайте дефисы -, чтобы подчеркнуть _

  • Легко печатать
  • Лучший разделитель слов: попробуйте использовать Ctrl + ← или Ctrl + →, курсор остановится для каждого -, но не для _ (в зависимости от конфигурации оболочки/слова )

Ответ 3

Также известный как кебаб-кейс, looks-like-this. Легко печатать, легко читать.

Ответ 4

Исходя из моего опыта, я бы предложил придерживаться строчных и дефисов. У нас была проблема, когда код нашей конвейерной библиотеки использовал имя git org и имя репозитория в теге изображения Docker. Если ваше имя org/repo содержит заглавные буквы, вы столкнетесь с ошибкой вроде

msgstr "неверный формат ссылки: имя репозитория должно быть в нижнем регистре (неверный запрос: 400)".
Если вы не планируете использовать их в теге изображения докера, тогда хорошо, но ввод заглавных букв означает, что вы ограничиваете свои возможности.

Ответ 5

Из того, что я видел на GitHub и читал с разных веб-сайтов, он выглядит строчными, а дефисы, похоже, популярны в использовании. Я предпочитаю использовать "ProjectName" для моих проектов, так как он кажется мне чище.