From 5b5bc6d53cd9769276b77cc425eb60b4dfa461d3 Mon Sep 17 00:00:00 2001 From: Gunnsteinn Hall Date: Mon, 13 Jul 2026 21:48:27 +0200 Subject: [PATCH] docs: remove internal BMAD tooling references before going public --- CODE_REVIEW.md | 1 - CONTRIBUTING.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/CODE_REVIEW.md b/CODE_REVIEW.md index 19f4a83..7b21449 100644 --- a/CODE_REVIEW.md +++ b/CODE_REVIEW.md @@ -104,7 +104,6 @@ Per Unix convention 2 is typically misuse, 1 is generic failure, >2 application- - The `pdfservice` package is a thin proxy over `Inspector`. Consider whether you actually need the package boundary. `Inspector` itself could be the Wails service. Smaller surface area. - The Go side does most of the heavy lifting; the React side has more state than it should (per-tab caches, navigation history, batch progress, palette state, find-bar state across hooks). Consider whether `useReducer` over a single store wouldn't be cleaner. The current sprawl makes test scaffolding heavy (1453-line `useDocumentState.test.tsx`). -- `_bmad-output` and `_bmad` symlinks into a sibling repo (`../docs`) make the build sensitive to repo layout; a CI clone with submodules or git-subtree would be more robust than a bare relative symlink. ## Top priorities diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1ee3f1e..b358e22 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ golangci-lint run ./... Do NOT add new `strings.Contains`, `regexp.Match`, or other file-content assertions against `main.go`, `frontend/src/components/MainLayout.tsx`, or `frontend/src/components/EmptyState.tsx` from any test under `tests/`. If you find yourself reaching for that pattern, write a behavioural test (Vitest, Playwright, or `tests/boot-smoke`) instead. -Pre-existing structural greps in those files are grandfathered (see `docs/_bmad-output/implementation-artifacts/deferred-work.md` for the bulk-removal follow-up tracked under story 4-5). Do not extend the pattern. Reviewers must flag new source-greps at PR time. +Pre-existing structural greps in those files are grandfathered pending a bulk-removal follow-up. Do not extend the pattern. Reviewers must flag new source-greps at PR time. Generated build artifacts (`build/linux/*.desktop`, `build/darwin/Info.plist`, etc.) are exempt -- parsing those is legitimate behavioural testing on a build output, not source.