35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
# Шаблон тела issue
|
|
|
|
Задача должна быть самодостаточной: открыв её через неделю, должно быть понятно, что делать, без дополнительных вопросов.
|
|
|
|
```markdown
|
|
## Описание
|
|
Контекст: почему задача возникла, какую проблему решает. Ссылки на связанные issue и ADR.
|
|
|
|
## Желаемый результат
|
|
Конкретно и проверяемо. Пример:
|
|
- «На отправку `.py`-файла бот отвечает ссылкой на коммит в течение 5 с»
|
|
|
|
## Подзадачи
|
|
- [ ] Подзадача 1 — конкретный шаг, указать файл/модуль
|
|
- [ ] Подзадача 2
|
|
|
|
## Анализ
|
|
### Затрагиваемые файлы
|
|
| Файл | Что меняется |
|
|
|------|--------------|
|
|
|
|
### Ограничения и риски
|
|
Edge cases, безопасность (чужой код!), секреты, лимиты Telegram API.
|
|
|
|
## Как проверить
|
|
Шаги/команды и ожидаемый результат.
|
|
|
|
---
|
|
|
|
## Лог выполнения
|
|
```
|
|
|
|
> Лог дополняется секцией `### YYYY-MM-DD` при каждой рабочей сессии.
|
|
> Issue закрывается, когда все подзадачи выполнены и ветка смержена.
|