Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,12 @@ stitch/
skills/.gitkeep
skills/*
website/
docs/
# Curated docs that should live in-repo carve out of the gitignore.
# Pattern is ``docs/*`` (contents) + explicit ``!docs/<tracked>/``
# negations — NOT ``docs/`` (directory), because git won't descend into
# an excluded directory to honour child negations.
docs/*
!docs/review/
heartbeat.log
.coverage
output/
39 changes: 39 additions & 0 deletions docs/review/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Review heuristics

This directory holds shared review and authoring heuristics for the agent
pool — frameworks that compound across PRs when every agent applies the
same checklist at *write* time, not just at review time.

## Why this directory is tracked

`docs/` is gitignored by default so scratch design notes and local-only
investigation don't accidentally get committed. `docs/review/` is carved
out as an explicit tracked subdir because the heuristics here are
intended to outlive any single PR and to be discoverable next to the
source they shape.

If you want to add another always-tracked docs subdirectory in the
future, follow the same pattern: add `!docs/<name>/` to `.gitignore`
in its own small PR, then ship the actual content separately so the
review of the carve-out doesn't get tangled with the review of the
content.

## Current docs

- _Placeholder — heuristics doc landing in a follow-up PR._

## Adding a new heuristic

Heuristics earn their place by surviving the same discipline they
impose:

1. **n=2 cross-domain** for case-shaped detectors (mechanical detectors
for bug-shape patterns).
2. **Mechanical detector required** — broad pattern recognition without
a detector belongs in an open-observations appendix, not a numbered
case.
3. **Self-application** — if the framework can't survive being applied
to itself, it's not strong enough yet.

Open observations (n=1 candidates) and case candidates that lack sharp
detectors live in appendices, not the main framework.
Loading