docs: README по требованиям оформления и демо-скрипты #19

New Issue

2026-10-12T19:35:29+03:00

Eleboba commented

2026-10-12 19:35:29 +03:00

Описание

«Требования к оформлению решений» (pdf в meditron): README с обязательными разделами, демо-данные. Финализируется после M2–M3, но структура и examples нужны раньше для ручных проверок.

Желаемый результат

README разделы: 1. Цели и задачи · 2. Что реализовано · 3. Развёртывание и запуск (требования, установка, запуск, .env) · 4. Входные и выходные данные, команды бота, используемые API · 5. Ограничения и особенности (безопасность чужого кода, лимиты) · Структура репозитория.
examples/: hello_service.py, job_ok.py, syntax_error.py, lint_fail.py, crash.py, cpu_hog.py, escape_attempts.py, with_tests/.

Подзадачи

Скелет README с разделами
examples/ + examples/README.md — что демонстрирует каждый
Финальное наполнение после M3
Скриншоты/гиф диалогов в docs/assets/

Анализ

Затрагиваемые файлы

Файл	Что меняется
`README.md`	переписать
`examples/`	новый

Ограничения и риски

README — для проверяющего: запуск с нуля должен работать по инструкции дословно.

Как проверить

Человек, не видевший проект, поднимает бота по README на своей машине.

Лог выполнения

Перенесено из SourceCraft: https://sourcecraft.dev/rogachevegorushka/tgit/issues/19

## Описание «Требования к оформлению решений» (pdf в meditron): README с обязательными разделами, демо-данные. Финализируется после M2–M3, но структура и examples нужны раньше для ручных проверок. ## Желаемый результат README разделы: 1. Цели и задачи · 2. Что реализовано · 3. Развёртывание и запуск (требования, установка, запуск, `.env`) · 4. Входные и выходные данные, команды бота, используемые API · 5. Ограничения и особенности (безопасность чужого кода, лимиты) · Структура репозитория. `examples/`: `hello_service.py`, `job_ok.py`, `syntax_error.py`, `lint_fail.py`, `crash.py`, `cpu_hog.py`, `escape_attempts.py`, `with_tests/`. ## Подзадачи - [ ] Скелет README с разделами - [ ] `examples/` + `examples/README.md` — что демонстрирует каждый - [ ] Финальное наполнение после M3 - [ ] Скриншоты/гиф диалогов в `docs/assets/` ## Анализ ### Затрагиваемые файлы | Файл | Что меняется | |------|--------------| | `README.md` | переписать | | `examples/` | новый | ### Ограничения и риски README — для проверяющего: запуск с нуля должен работать по инструкции дословно. ## Как проверить Человек, не видевший проект, поднимает бота по README на своей машине. --- ## Лог выполнения > Перенесено из SourceCraft: https://sourcecraft.dev/rogachevegorushka/tgit/issues/19

Eleboba added this to the M4 · Сдача milestone 2026-10-12 19:35:29 +03:00

Eleboba added the feature docs size/1 labels 2026-10-12 19:35:29 +03:00

Eleboba self-assigned this 2026-10-12 19:35:29 +03:00

Eleboba added a new dependency 2026-10-12 19:45:19 +03:00

#20 docs: презентация и демо-сценарий защиты

Eleboba referenced this issue from a commit

2026-10-17 15:53:06 +03:00

fix(alerts): краш при restart-политике, гистерезис закрытия, редкие правки

Eleboba referenced this issue from a commit

2026-10-17 15:57:10 +03:00

docs: README по требованиям к оформлению и демо-сервисы examples/ (#19)

Eleboba referenced a pull request that will close this issue