Skip to content

Instantly share code, notes, and snippets.

@maestrow

maestrow/repo-naming-conventions.md

Last active September 1, 2024 14:51
Show Gist options
  • Save maestrow/9b97fa931d5995fe0cbfc65d13020bb0 to your computer and use it in GitHub Desktop.
Save maestrow/9b97fa931d5995fe0cbfc65d13020bb0 to your computer and use it in GitHub Desktop.
Download ZIP
Соглашение об именовании репозиториев
Raw
repo-naming-conventions.md

Общие правила

Рассмотрим произвольный проект с именем "Some Cool Project". Варианты имени репозитория для данного проекта:

  1. somecoolproject
  2. SomeCoolProject
  3. some-cool-project
  4. some_cool_project
  5. Some-Cool-Project

Вариант some-cool-project считаем предпочтительным. Аргументы за:

  • Сообщество github предпочитает такой стиль: some-cool-project
  • Набирать "-" проще чем "_"

Можно использовать комбинированный вариант: poc-webBgTasks, если количество частей имени, разделяемых "-" становится велоко.

Следует помнить, что независимо от имени репозитория его можно склонировать в папку с любым именем: git clone https://github.com/author/repo MyFolder.

Классификация репозиториев

Одним из вариантов отмечать к какой категории относится репозиторий - использовать префиксы. Т.о. в списке однотипные репозитории будут сгруппированы - их проще пролистать, если нас не интересуют, например, репозитории с документацией.

Префиксы:

  • poc Proof Of Concept
  • howto HowTo
  • doc Documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment