CLAUDE.md
Проект
Кейс: <название, 1 строка>
Что делаем: <одно предложение — какую боль закрываем и что делает агент>
Стек
- Язык/рантайм: <напр. Python 3.12 / Node 20>
- Ключевые либы/фреймворки: <...>
- Где запускается: <локально / внутри периметра>
Как запустить
# установка
<команды>
# запуск
<команды>
Структура
src/— <...>data/— синтетические/обезличенные данные (реальные не кладём)README.md— описание кейса, боль, метрикиdocs— документация
Чего НЕ делать
- Не трогаем реальный прод и боевую инфру.
- Секреты — только в
.env(он в.gitignore), не коммитим и не отправляем в чат. - Работаем на синтетике/обезличенных данных.
Договорённости
- Коммиты осмысленные, пушим регулярно.
- <ваши конвенции: стиль кода, нейминг и т.п.>
Дополнительно
Критические запреты
- Никогда не создавать
.bak,.old,.backup,*_old.*файлы — использовать Git - Никогда не создавать tar.gz/zip архивы как бэкапы
- Не хардкодить URL, порты, API-ключи — только через
.env/ config - Не коммитить
.envс секретами - Не удалять тесты и данные без явного указания
- Секреты: только через переменные окружения
Git и версионирование
- Коммит после каждой итерации — атомарные изменения
- Conventional commits:
feat:,fix:,refactor:,docs:,chore: - Semantic versioning: major (breaking), minor (фича), patch (багфикс)
Документация — держать актуальной
| Файл | Когда обновлять |
|---|---|
docs/todo.md | Начало/завершение задачи, новая задача, смена статуса |
docs/rec.md | Архитектурное решение, баг, tech debt |
docs/TECHNICAL_SPEC.md | Новый endpoint, схема данных, экран UI, стек |
docs/README.md | Порты, способ запуска, ключевые зависимости |