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

Я работаю с небольшим набором проектов, поэтому мне не хватает знаний о соглашении об именах для каталогов в иерархии файлов проекта программного обеспечения, которое необходимо для ведения разработки проекта.

Я смотрю на известные проекты (такие как Firefox, GCC, binutils, Linux, Emacs, VIM и т. д.) и собираю некоторые общие каталоги (комментарии написаны мной, поэтому они не претендуют на правду...):

  • examples или samples, чтобы показать практическое использование проекта в мини-скриптах, мини-программах или мини-конфигурациях.
  • scripts, support - обертки или копии отсутствующих скриптов/утилит для обеспечения межсредовой сборки.
  • tools - дополнительные утилиты для профилирования или отладки проекта.
  • contrib - пользовательские скрипты, конфиги и т.д...
  • misc, etc - файлы без категорий (если вы не знаете, где им нужное место).
  • config, extra - не знаю...

Хотя src/, test/, build/, dist/, lib/ и другие соглашения об именах каталогов продиктованы prog-langs/platforms/frameworks и т. д., эти каталоги кажутся общими для всех типов проектов.

Поэтому я ищу руководство (официальное или неофициальное) по соглашению об именах для каталогов, содержащих файлы поддержки для проекта.

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

ПС. Кто-то может возразить, что это не ТАК вопрос. Но у меня есть настоящая задача зафиксировать несколько скриптов (скрипт sql для дампа меню из БД, скрипт, который сбрасывает сопоставление URL-адресов для веб-контроллеров и т. д.) и искать имя каталога, в котором должны храниться эти файлы...

ППС. Мои усилия по сбору конвенций:


person gavenkoa    schedule 07.02.2013    source источник


Ответы (1)