Skip to content

docs(conventions): rules encode intent; trim, update and add releases and generation - #40

Merged
tskovlund merged 1 commit into
mainfrom
claude/conventions-rewrite-tw2mrz
Sep 28, 2026
Merged

tskovlund merged 1 commit into
mainfrom
claude/conventions-rewrite-tw2mrz

Conversation

@tskovlund

Copy link
Copy Markdown
Owner

Applies the prepared conventions rewrite.

  • conventions/general.md opens with "How to read these": follow the intent of a rule, nothing is maintained for its own sake, generate over hand-maintain. Testing asks for critical paths and tests that each catch a regression, with no coverage target. The quality gate is described tool-agnostically. The archetype list names no repositories or hypothesis. A bounded reconnect is allowed, blind retry loops are not. Branch, PR and squash merge is the default flow. Releases are tags with notes drafted from conventional commits and curated on GitHub Releases; there is no changelog file. Docs state what the code does not say. AGENTS.md is the agent instruction file with no CLAUDE.md symlink.
  • conventions/python.md: Any only at boundaries; docstrings explain semantics with Google-style sections.
  • conventions/typescript.md: no any escape hatch; same docstring rule.
  • CONVENTIONS.md regenerated with scripts/assemble-conventions.sh.
  • This repo's own CLAUDE.md symlink is removed.

Prettier passes on the tree.

🤖 Generated with Claude Code

https://claude.ai/code/session_01U2LtVuEjWWeYigS7mwFL5L


Generated by Claude Code

… and generation

The general conventions open with how to read them: follow the intent,
not the letter; nothing is maintained for its own sake; generate over
hand-maintain. Testing asks for the critical paths and tests that each
catch a regression, not a coverage percentage. The gate is tool-agnostic
instead of `make` targets, the per-archetype table no longer names repos
or hypothesis, retries allow a bounded reconnect, and the branch-and-PR
flow with squash merges is the default. Releases are tags with notes
drafted from commits and curated on GitHub; there is no changelog file.
Docs state what the code does not and never carry drifting counts.
AGENTS.md needs no CLAUDE.md symlink now that Claude Code reads it;
this repo's own symlink goes too. Python and TypeScript modules add the
no-escape-hatch and docstring-semantics rules.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019ydLojugUs3zcsJbN9axQF
@tskovlund
tskovlund merged commit 36516a5 into main Sep 28, 2026
1 check passed
@tskovlund
tskovlund deleted the claude/conventions-rewrite-tw2mrz branch October 8, 2026 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant