44 lines
1.3 KiB
Markdown
44 lines
1.3 KiB
Markdown
# Conventional Commits
|
|
|
|
## Формат
|
|
|
|
```
|
|
<тип>[optional scope]: <описание>
|
|
|
|
[optional body]
|
|
[optional footer]
|
|
```
|
|
|
|
## Типы
|
|
|
|
| Тип | Описание | Влияние на версию |
|
|
|-----|----------|-------------------|
|
|
| `feat` | Новая функция | MINOR |
|
|
| `fix` | Исправление бага | PATCH |
|
|
| `BREAKING` | Несовместимое изменение (или `!` после типа) | MAJOR |
|
|
| `docs` | Документация | — |
|
|
| `style` | Форматирование | — |
|
|
| `refactor` | Рефакторинг | — |
|
|
| `test` | Тесты | — |
|
|
| `chore` | Обслуживание (deps, ci, конфиги) | — |
|
|
|
|
## Примеры для VoIdea
|
|
|
|
```
|
|
feat(api): add POST /ideas/{id}/analyze endpoint
|
|
fix: validate email format on registration
|
|
BREAKING: change API response format for ideas list
|
|
docs: add architecture overview
|
|
refactor: extract AnalysisService from api/ideas.py
|
|
test: add integration tests for auth endpoints
|
|
chore: add pre-commit config
|
|
chore(deps): update fastapi to 0.115.6
|
|
```
|
|
|
|
## Правила
|
|
|
|
- Описание в императиве (начинается с глагола)
|
|
- Без точки в конце заголовка
|
|
- Заголовок до 72 символов
|
|
- Тело коммита — ЧТО и ЗАЧЕМ, а не КАК
|