Home

boring / v2

publicBoring-Software-Inc/v2
Overview Code History Branches Pull requestsIssuesInsights Campfire Docs
main
HomeOverview Code PRsIssues

docs: overview, agent guidelines, and the rule ideas on paper

2 months ago

22e1609
Authored
grim8/23/2026, 8:14:06 AM
OVERVIEW.md is the page open-git renders for the repo, so it leads with what
tripwire is for rather than how to run it. It names no active rule.

Agentic use is a section, not a footnote, because it is the honest description
of how this repo was built. It explains WHY the repo suits an agent — pure
rules, enforced arrows, strict types, one command per check — rather than just
claiming it does.

agent-guidelines.md writes down the rules that were spoken but never recorded:
lint and typecheck before the PUSH not the pull request, no any and no cast
past an error, a ui change carries a before and after, commits keep their
shape, and a giant pull request gets split. Every rule is a command an agent
can run. Each says why, because a rule without a reason gets worked around.

The same rules are in CONTRIBUTING.md for human contributors, so neither
audience has to read the other's file.

rule-ideas.md parks two product ideas: required media for a tagged change, and
a forge-side commit standard. Both are recorded with why they are HARD — the
media rule can prove an image exists but not that it is honest, and the commit
rule is mostly moot under squash-merge. Nothing here is built or scheduled.

Parent9036ef8

5 files changed
  • OVERVIEW.md+201−0
  • docs/CONTRIBUTING.md+57−1
  • docs/LICENSE-EXPLAINED.md+4−3
  • docs/agent-guidelines.md+211−0
  • docs/rule-ideas.md+104−0