mirror of
https://github.com/Ku6epXBOCTuK/easy-png-tools.git
synced 2026-11-13 17:08:20 +00:00
docs: update plans, backlog, move todo\fixme from code comments
This commit is contained in:
+17
-10
@@ -8,23 +8,19 @@
|
||||
|
||||
1. `AGENTS.md` — команды и обязательные инварианты.
|
||||
2. Этот файл — выбрать актуальный документ по теме.
|
||||
3. `docs/plan-codebase-quality.md` — текущий план приведения качества в порядок
|
||||
и последовательность следующих шагов.
|
||||
4. Соответствующий план или checklist темы.
|
||||
5. Исходники, конфигурация и тесты рядом с изменяемым кодом.
|
||||
3. Соответствующий план или checklist темы.
|
||||
4. Исходники, конфигурация и тесты рядом с изменяемым кодом.
|
||||
|
||||
## Активные документы
|
||||
|
||||
| Документ | Роль | Статус |
|
||||
| ---------------------------------- | ---------------------------------------------------- | ------ |
|
||||
| `AGENTS.md` | Краткий обязательный контракт для агента | active |
|
||||
| `docs/plan-codebase-quality.md` | План quality gates, тестов и lint-правил | draft |
|
||||
| `docs/agent-workflow.md` | Подробный порядок исследования, изменения и проверки | active |
|
||||
| `docs/testing-strategy.md` | Locator, fixture, i18n и fixme-policy для e2e | active |
|
||||
| `docs/quality-gates.md` | Команды проверки, warnings и CI | active |
|
||||
| `docs/backlog.md` | Продуктовые, UX- и инфраструктурные задачи | active |
|
||||
| `docs/roadmap.md` | Общие направления развития | active |
|
||||
| `docs/plan-redesign.md` | Новый дизайн production UI | active |
|
||||
| `docs/plan-seo.md` | SEO/GEO-план | active |
|
||||
| `docs/plan-platform.md` | PWA/API/WASM-план | active |
|
||||
| `docs/checklist-manual-testing.md` | Ручная приёмка production UI | active |
|
||||
@@ -47,13 +43,22 @@
|
||||
`web/eslint-plugins/README.md` и исходниках правил.
|
||||
- Продуктовые решения и ручная приёмка — в backlog, плане и checklist.
|
||||
|
||||
У документа должен быть один источник истины: остальные файлы ссылаются на него,
|
||||
а не пересказывают. Подробные материалы хранятся в `docs/`, чтобы не засорять
|
||||
корень репозитория. Не создавать отдельные `docs/commands.md`,
|
||||
`docs/known-issues.md` или копию backlog: команды принадлежат `quality-gates`,
|
||||
известные проблемы — backlog и checklist. `README.md` в корне остаётся кратким
|
||||
обзором продукта, а не вторым руководством агента.
|
||||
|
||||
Новый документ создаётся только когда темы нет в существующем файле; иначе
|
||||
обновляется источник истины. Активный документ имеет статус (`draft`, `active`,
|
||||
`completed`) и понятную область применения.
|
||||
|
||||
Подробные материалы хранятся в `docs/`, а не в корне. Новый файл создаётся
|
||||
только если темы нет в существующем документе; иначе обновляется источник
|
||||
истины.
|
||||
|
||||
## Текущий baseline Q7a
|
||||
|
||||
На момент фиксации Q7a:
|
||||
## Текущий baseline
|
||||
|
||||
- production registry содержит 122 инструмента;
|
||||
- `pnpm --dir web check` проходит без ошибок и предупреждений;
|
||||
@@ -69,7 +74,9 @@
|
||||
skipped, 0 failed. Отказ декодера битого PNG зафиксирован per-engine в
|
||||
`web/e2e/png-fixtures.spec.ts`.
|
||||
|
||||
Baseline и следующий шаг поддерживаются в `docs/plan-codebase-quality.md`.
|
||||
Состав проверок и их семантика описаны в `docs/quality-gates.md`, тестовая
|
||||
архитектура — в `docs/testing-strategy.md`. Baseline обновляется здесь при
|
||||
изменении любого из гейтов.
|
||||
|
||||
## Правила актуальности
|
||||
|
||||
|
||||
Reference in New Issue
Block a user