starterKit

Нулевой репозиторий для старта новых проектов

---

Содержание

• О проекте
• Структура репозитория
• Как использовать
• Документация
• Коммиты
• Принципы

---

О проекте

Проблема

Когда новый проект начинается с пустой папки, команда тратит время на одинаковые стартовые решения: где хранить код, как отделять документацию от реализации и как объяснить структуру новым участникам

Решение

starterKit даёт нейтральный и повторяемый каркас. Репозиторий можно форкнуть под конкретный продукт, а затем заполнить его приложением, пакетами, документацией и инфраструктурой без перестройки общей формы

---

Структура репозитория

Зоны ответственности

• app/ — прикладные приложения;
• packages/ — переиспользуемые пакеты и общие библиотеки;
• docs/ — архитектурная и проектная документация;
• infrastructure/ — контейнеризация, CI/CD, nginx и служебные скрипты

---

Как использовать

1. Форкните или скопируйте репозиторий под свой проект.
2. Определите, какие части будут жить в app/ и packages/.
3. Заполните документы в docs/ под ваш конкретный стек и домен.
4. Настройте infrastructure/ под сборку, доставку и развёртывание.
5. При необходимости добавляйте новые зоны, но сохраняйте тот же принцип разделения ответственности

---

Документация

Стартовые документы находятся в docs/:

• Архитектура
• API
• База данных
• Вклад в проект

Если вы расширяете структуру репозитория, сразу добавляйте документацию для новой зоны и фиксируйте её назначение, границы и правила использования

---

Коммиты

Чтобы история изменений оставалась читаемой и пригодной для автоматизации, используйте стандарт Conventional Commits

Формат

type(scope): subject

Рекомендуемые типы

• feat — новая функциональность;
• fix — исправление ошибки;
• docs — изменения в документации;
• refactor — рефакторинг без изменения поведения;
• chore — служебные изменения;
• test — добавление или обновление тестов;
• build — изменения в сборке и зависимостях;
• ci — изменения в CI/CD