Этот репозиторий предназначен для стартовой структуры будущих проектов. Вклад здесь обычно связан с тремя областями:
| Направление | Примеры вклада |
|---|---|
| Документация | Уточнение структуры, правил и шаблонов |
| Структура | Новые папки, пакеты и общие соглашения |
| Инфраструктура | Docker, CI/CD, служебные скрипты |
Понять нужно не только что меняется, но и к какой части каркаса это относится: app/, packages/, docs/ или infrastructure/
Изменение должно быть небольшим и понятным по назначению. Если оно затрагивает несколько зон, лучше разделить его на несколько шагов
Если новая папка, пакет или процесс меняют логику работы репозитория, это должно быть отражено в docs/ и при необходимости в корневом README.md
- одно изменение должно решать одну задачу;
- новые зоны должны иметь понятное назначение;
- документация не должна расходиться со структурой репозитория;
- служебные файлы и временные артефакты не должны попадать в историю;
- изменения должны быть нейтральны к будущему стеку, если это возможно
Используйте формат Conventional Commits:
type(scope): subject
| Type | Назначение |
|---|---|
feat |
Новая функциональность |
fix |
Исправление ошибки |
docs |
Изменения в документации |
refactor |
Рефакторинг без изменения поведения |
chore |
Служебные изменения |
test |
Тесты и тестовая инфраструктура |
build |
Сборка и зависимости |
ci |
CI/CD и пайплайны |
- Subject пишите кратко и в повелительном наклонении.
- Один коммит должен описывать одну логическую правку.
- Не смешивайте в одном коммите несвязанные изменения.
- Scope выбирайте по основной зоне изменения.
Перед отправкой PR проверьте, что описание соответствует изменениям, а документация и структура не конфликтуют между собой. Для нулевого репозитория особенно важно, чтобы каждый PR сохранял нейтральность шаблона и не вносил привязку к конкретному продукту без необходимости