docs: скелет проекта — CLAUDE.md, регламент, шаблон issue, черновик ТЗ

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
2026-10-12 18:11:22 +03:00
co-authored by Claude Opus 5.5
parent a5d1e90aab
commit b973397827
9 changed files with 254 additions and 1 deletions
+34
View File
@@ -0,0 +1,34 @@
# Шаблон тела issue
Задача должна быть самодостаточной: открыв её через неделю, должно быть понятно, что делать, без дополнительных вопросов.
```markdown
## Описание
Контекст: почему задача возникла, какую проблему решает. Ссылки на связанные issue и ADR.
## Желаемый результат
Конкретно и проверяемо. Пример:
- «На отправку `.py`-файла бот отвечает ссылкой на коммит в течение 5 с»
## Подзадачи
- [ ] Подзадача 1 — конкретный шаг, указать файл/модуль
- [ ] Подзадача 2
## Анализ
### Затрагиваемые файлы
| Файл | Что меняется |
|------|--------------|
### Ограничения и риски
Edge cases, безопасность (чужой код!), секреты, лимиты Telegram API.
## Как проверить
Шаги/команды и ожидаемый результат.
---
## Лог выполнения
```
> Лог дополняется секцией `### YYYY-MM-DD` при каждой рабочей сессии.
> Issue закрывается, когда все подзадачи выполнены и ветка смержена.
+55
View File
@@ -0,0 +1,55 @@
# Регламент работы
## Откуда задачи
- Только из Issues на SourceCraft. Нет issue → завести → потом код.
- Атрибуты issue: исполнитель, метка зоны (`bot` / `ci` / `infra` / `llm` / `docs`),
тип (`feature` / `fix` / `refactor` / `docs`), размер (`size/0.5` ≈ 2ч · `size/1` ≈ 4ч · `size/2` ≈ 1д).
- Тело — по [`ISSUE_TEMPLATE.md`](ISSUE_TEMPLATE.md).
## Жизненный цикл задачи
```
1. Взял issue
2. git fetch origin && git switch -c <type>/<issue#>-<slug> origin/dev
3. Код по модулям; коммиты с Refs #N
4. git rebase origin/dev
5. lint + тесты
6. Лог в issue: ### YYYY-MM-DD
7. PR в dev с Closes #N
8. Мерж → ветку удалить
```
## Ветки
```
main (сдаваемая версия) ←── мержит только человек
dev (интеграция) ←── сюда все PR
<type>/<issue#>-<slug> ←── от dev
```
## Коммиты — Conventional Commits
```
feat(bot): принимать .py-файлы и коммитить в репозиторий загрузок
Refs #12
```
## Шаблон PR
```markdown
## Что меняется
1–3 предложения.
Closes #<N>
## Как проверить
шаги/команды
## Чек-лист
- [ ] rebase на origin/dev
- [ ] lint + тесты зелёные
- [ ] секретов в диффе нет
- [ ] лог в issue дописан
```