docs: clean up project markdown

This commit is contained in:
Mikhail Kilin
2026-05-17 03:56:04 +03:00
parent 90776448ce
commit 1208aa5afb
12 changed files with 287 additions and 2099 deletions

View File

@@ -1,110 +1,43 @@
# Правила локальной разработки
> **Обязательно к прочтению перед началом работы!**
---
# Разработка
## Инструменты
### MCP серверы
- **Serena** — для работы с кодом (символьная навигация, редактирование)
- **Context7** — для получения актуальной документации по библиотекам
- Для поиска используй `rg`.
- Для точечной навигации по Rust-коду можно использовать Serena.
- Для актуальной документации библиотек используй Context7, если это нужно для изменения.
Используй эти инструменты для эффективной работы с кодовой базой.
## Cargo-команды
---
Агентам нельзя самостоятельно запускать:
## Правила работы
### 1. Никогда не запускай сервисы самостоятельно
**ЗАПРЕЩЕНО** запускать `cargo run`, `cargo build` и подобные команды.
**Вместо этого попроси пользователя запустить:**
```
Запусти, пожалуйста:
```bash
cargo run
cargo build
cargo test
cargo check
```
### 2. Тестирование — только ручное
Исключение: пользователь прямо попросил запустить конкретную cargo-команду.
После завершения задачи:
1. Опиши сценарии для проверки
2. Попроси пользователя проверить вручную
3. Дождись фидбека
В финальном ответе после изменения укажи, какие cargo-команды не запускались, и дай минимальную ручную проверку.
**Формат:**
```
Готово! Проверь, пожалуйста:
## Scope
1. Открой cargo run
2. понавигируйся в списке чатов кнопками h j k l
3. Нажми Enter для открытия чата
4. Убедись, что чат прогурзился
- Делай одну логическую правку за раз.
- Не смешивай feature work, рефакторинг и документацию без необходимости.
- Не откатывай чужие изменения в dirty worktree.
- Не используй destructive git-команды без явной просьбы.
Напиши, если что-то не работает.
## Ручная проверка
Формат после функциональной правки:
```text
Проверь:
1. Запусти ...
2. Открой ...
3. Выполни ...
4. Ожидаемый результат: ...
```
### 3. Работа поэтапно
Делай работу **небольшими итерациями**:
1. **Один этап = одна логическая единица**
- Один endpoint
- Один компонент
- Одна фича
2. **После каждого этапа:**
- Сообщи что сделано
- Дай сценарий проверки
- Дождись подтверждения
3. **Не делай сразу много:**
- ❌ Весь CRUD за раз
- ✅ Сначала GET, проверили, потом POST, проверили...
---
### 4. Работа с git
НИКОГДА НЕ КОММИТЬ ИЗМЕНЕНИЯ ПОКА ТЕБЯ НЕ ПОПРОСЯТ!!!
## Чеклист перед началом работы
- [ ] Прочитал CONTEXT.md
- [ ] Прочитал ROADMAP.md (понял текущую фазу)
- [ ] Понял задачу
- [ ] Готов работать поэтапно
- [ ] Помню: не запускаю сервисы сам, прошу пользователя
---
## Пример правильного workflow
```
Пользователь: Сделай endpoint для получения списка идей
Агент:
1. Читает документацию через Context7 (NestJS, TypeORM)
2. Использует Serena для навигации по коду
3. Создаёт endpoint GET /api/ideas
4. Сообщает:
"Создал endpoint GET /api/ideas.
Запусти backend:
cd backend && npm run dev
Проверь:
curl http://localhost:4001/api/ideas
Должен вернуться пустой массив: { data: [], meta: {...} }"
5. Ждёт фидбек
6. Переходит к следующему этапу
```
## Работа с git
- никогда не добавляй себя в соавторов в тексте коммита
Для чисто документационных задач cargo-проверки не требуются.