chore: carve out docs/review/ as a tracked subdirectory - #499
Open
olegbrok wants to merge 1 commit into
Open
Conversation
Adds an explicit ``!docs/review/`` negation in .gitignore so curated review/authoring heuristics can live in-repo alongside the source they shape. Everything else under ``docs/`` (loose design notes, scratch investigation files, etc.) stays gitignored by the new ``docs/*`` pattern. Note: the negation requires the parent pattern to match contents (``docs/*``), not the directory (``docs/``). Git won't descend into an excluded directory to honour child negations, so the previous ``docs/`` line had to be widened. A placeholder ``docs/review/README.md`` is included so the directory is real and the carve-out has something to track. The shared review heuristics doc itself lands in a follow-up PR (drafted locally by Pushok during PR #496's iteration) to keep the carve-out review separate from the content review. Minimal-scope by design — additional tracked docs subdirs (``!docs/architecture/`` etc.) can carve out in their own small PRs when there's real content to land. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Carves out
docs/review/as a tracked subdirectory so curatedreview/authoring heuristics can live in-repo alongside the source
they shape. Everything else under
docs/stays gitignored.The shared review heuristics doc itself (drafted by Pushok during
PR #496's iteration arc, covering matrix-delta-first / concurrency
lens / five-cases framework with composition-drift / fail-on-broken
discipline / tagged-observation pattern) lands in a follow-up PR
to keep the carve-out review separate from the content review.
Why
PR #496 surfaced enough cross-agent review discipline that
externalizing it pays off. Three contributors (Pushok, Murzik, me)
each have complementary review lenses; a single canonical reference
that any agent can load on review tasks means we stop re-deriving
the same heuristics across PRs.
Minimal-scope on purpose — additional always-tracked docs subdirs
(
!docs/architecture/etc.) can carve out in their own small PRswhen there's actual content to land.
Implementation note
Gitignore negations don't work when the parent directory is fully
excluded — git won't descend into
docs/to honour!docs/review/if it's already pruned the directory. Widened to
docs/*(contents)Test plan
git check-ignore -v docs/scratch.md→ ignored ✓git check-ignore -v docs/review/README.md→ tracked ✓docs/still don't getaccidentally committed
🤖 Opened by Barsik