Docs/1.2 private notes (#5)
<!-- Название PR: «[ID] Что сделано», по-русски. Например: [2.11] Изоляция организаций --> **Задача:** #<!-- ID задачи в дорожной карте --> **Пункты:** <!-- 2.11.4, 2.11.6 --> ## Что сделано - ## Как проверить 1. ## Скриншоты <!-- Для изменений интерфейса. Иначе удалить раздел. --> ## Чек-лист - [ ] Коммиты и название PR по-русски, в каждом коммите есть `Refs:` - [ ] Ветка свежая: `git rebase origin/main`, конфликтов нет - [ ] Запросы к данным организации — с `tenant_id` и через `WithTenantTx` - [ ] Права проверяются на сервере (`access.Require` / `ScopesFor`), интерфейс только скрывает - [ ] Новая функция — за флагом из каталога функций - [ ] Миграции только новые, смерженные не изменены; контракты (`api/`, `proto/`, `migrations/`) — отдельным PR - [ ] Тесты добавлены или обновлены; для новой таблицы организации — тест изоляции - [ ] Секретов и персональных данных в коде, логах и документах нет - [ ] Документация обновлена: запись журнала, `docs/status/`, ADR при значимом решении - [ ] Ссылка на этот PR добавлена в «Ссылки» задачи в дорожной карте Reviewed-on: #5 Co-authored-by: BrowenSiz <top.timashevsky@gmail.com>
This commit was merged in pull request #5.
This commit is contained in:
1 parent
dcee1faf7d
commit
800d000ac5
5 files changed
+83
-7
No files matched your search
@@ -22,6 +22,7 @@
|
||||
| `testing/` | shared | Тестовый стенд, сценарии доступа |
|
||||
| `research/` | shared | Интервью, исследования рынка |
|
||||
| `frontend/` | frontend | Внутренние правила Frontend: дизайн-система, компоненты, соглашения |
|
||||
| `private/` | только владелец | Личные заметки разработчика с AI. В `.gitignore`, в Gitea не попадает |
|
||||
| `backend/` | backend | Внутренние правила Backend: области сервера, агент, эксплуатация |
|
||||
| `environment.md` | shared | Версии инструментов и установка окружения (#1.3) |
|
||||
| `glossary.md` | shared | Словарь терминов (#2.1) |
|
||||
|
||||
+7
-1
@@ -37,6 +37,11 @@
|
||||
- **Читаешь:** `shared` + свою зону. Чужую зону — только если задача её касается (например, Frontend подключает эндпоинт и смотрит `docs/backend/` по нему).
|
||||
- **Пишешь:** свою зону + `shared`. Документы чужой зоны не редактируешь. Нашёл в них ошибку или нужна правка у другой стороны — запись в «Запросы между зонами» в `docs/status/shared.md`.
|
||||
- Чисто внутренние вещи зоны (дизайн-правила, вёрстка, внутренняя организация сервиса) остаются в документах зоны и **не попадают** в `shared`. Ассистент другой стороны их не читает и не тратит на них контекст.
|
||||
- **Личные заметки — `docs/private/`.** Папка в `.gitignore`: она есть только на компьютере владельца, в Gitea не попадает, второй разработчик и его AI её не видят. Это внутренний «чат» разработчика с AI: черновые мысли, личные договорённости с ассистентом, заметки по текущей работе, контекст между сессиями. Файлы: `docs/private/notes.md` (основной), при необходимости другие. Правила:
|
||||
- ассистент читает `docs/private/` в начале сессии и дописывает туда то, что нужно помнить только владельцу;
|
||||
- всё, что нужно другой стороне или проекту (решения, изменения поведения, договорённости), идёт в `docs/status`, `docs/journal` или ADR, а не только в `private`;
|
||||
- ассистент не переносит текст из `private` в файлы под git без согласия владельца;
|
||||
- секреты и пароли не хранятся и здесь — только в менеджере паролей. Резервную копию папки владелец делает сам.
|
||||
- **Как определить зону сессии:** 1) пользователь назвал её («зона: frontend»); 2) она задана в личных правилах разработчика (раздел 8); 3) по путям файлов задачи. Задача затрагивает обе зоны — работай как `shared` и спроси, кто делает вторую часть.
|
||||
|
||||
### Что обязательно идёт в `shared` (impact: shared)
|
||||
@@ -55,7 +60,7 @@
|
||||
Выполни по порядку и **не начинай писать код, пока не сделал шаги 1–5**:
|
||||
|
||||
1. `AGENTS.md` (обычно подгружается сам) и этот файл.
|
||||
2. `docs/status/shared.md` и `docs/status/<зона>.md`.
|
||||
2. `docs/status/shared.md`, `docs/status/<зона>.md` и личные заметки `docs/private/` (если папка есть; если нет — создай `docs/private/notes.md` по шаблону `docs/ai/templates/private-notes.md`).
|
||||
3. Журнал: последние 5 записей своей зоны и все записи `impact: shared` новее твоей последней записи (`docs/journal/`, имена файлов сортируются по дате).
|
||||
4. Дорожная карта: `node tools/roadmap-context/roadmap-context.mjs` (текущий шаг) и `... <ID задачи>` для задачи сессии. Подробности и запасные варианты — `docs/ai/roadmap.md`.
|
||||
5. Git: текущая ветка, `git status`, `git log --oneline -15 origin/main`. Есть ли смерженные PR другой стороны после последнего обновления статуса.
|
||||
@@ -88,6 +93,7 @@
|
||||
|
||||
Чек-лист:
|
||||
- [ ] Запись журнала ветки обновлена: сделано, решения, проверка, что осталось (`docs/ai/templates/journal-entry.md`).
|
||||
- [ ] Личное (черновые мысли, на чём остановились, что обсудить с собой) — в `docs/private/notes.md`.
|
||||
- [ ] `docs/status/<зона>.md` отражает текущее состояние: заменить устаревшее, а не дописать снизу.
|
||||
- [ ] Если есть impact `shared` — обновлён `docs/status/shared.md` (раздел «Готово для другой стороны» или «Запросы между зонами»).
|
||||
- [ ] Новый модуль, экран, компонент, паттерн, эндпоинт — описание в документах зоны (`docs/ai/templates/module.md`).
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# Личные заметки
|
||||
|
||||
Только на этом компьютере (`docs/private/` в `.gitignore`). В Gitea не попадает, второй разработчик не видит.
|
||||
Всё, что нужно проекту или другой стороне, — в `docs/status`, `docs/journal`, ADR. Секреты здесь не хранить.
|
||||
|
||||
## На чём остановились
|
||||
-
|
||||
|
||||
## Мысли и черновики
|
||||
-
|
||||
|
||||
## Договорённости с AI
|
||||
<!-- Как мне удобнее работать: стиль ответов, что проверять, что не делать без спроса. -->
|
||||
-
|
||||
|
||||
## Обсудить с напарником
|
||||
-
|
||||
@@ -77,6 +77,16 @@ git push --force-with-lease # после rebase, только в
|
||||
- Редактировать смерженную миграцию — только новая миграция.
|
||||
- Коммитить секреты, `.env`, ключи. Нашли секрет в истории — сразу сообщить второму, секрет перевыпустить.
|
||||
|
||||
## Что не коммитим
|
||||
Список — в `.gitignore`. Кратко:
|
||||
- **Секреты:** `.env`, ключи, сертификаты с закрытым ключом, файлы менеджера паролей. Шаблон переменных — только `.env.example` без значений. Пароли стенда — только в менеджере паролей.
|
||||
- **Личное:** `docs/private/` (заметки с AI), личные настройки AI-инструментов (`.cursor/`, `.windsurf/`, `.claude/`, `*.local.md`), `.mise.local.toml`. Общие правила для AI — только `AGENTS.md` и `docs/ai/`.
|
||||
- **Данные клиентов и дампы БД:** `*.dump`, `backups/` — там могут быть персональные данные.
|
||||
- **Прогресс дорожной карты** `roadmap/progress.json` — его хранит roadmap-server в отдельном репозитории.
|
||||
- **Сборка и зависимости:** `node_modules/`, `target/`, `dist/`, `bin/`, `*.exe`.
|
||||
|
||||
Перед коммитом gitleaks проверяет секреты. Если нужный файл попал под `.gitignore` — обсудить, а не добавлять через `git add -f`.
|
||||
|
||||
## Версии
|
||||
- До беты у всех компонентов одна версия репозитория. Тег ставится в конце шага: `v0.1.0` — шаг 2, `v0.2.0`…`v0.8.0` — шаги 3–9, `v0.9.x` — бета, `v1.0.0` — коммерческий релиз.
|
||||
- `CHANGELOG.md` собирается из коммитов (git-cliff) при постановке тега, поэтому формат коммитов важен.
|
||||
|
||||
Reference in new issue
Block a user