From c1758b1731ed032f0d78a3f831e381b771cd3ae9 Mon Sep 17 00:00:00 2001 From: Daniel McCoy Stephenson Date: Sun, 2 Aug 2026 23:02:52 -0600 Subject: [PATCH] Fold in round-2 readiness nice-to-haves: symlink flag, doc-table clarity, test comment MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - README.md: use ln -sf for the Installation symlink, matching Step 5's own registration convention (create-dev-loop.md:624). - CLAUDE.md: clarify that the ISSUE_TEMPLATE doc-table row's *.md glob deliberately excludes config.yml, which has no restatable conventions. - tests/test_check_docs.py: note in the module docstring that any new test class must reset check_docs.errors in its own setUp(), so a future addition doesn't silently leak state between tests. Not included, with reasons: - RESEARCH.md's "Observed effect: pending — needs N cycles of data" entries (PRs #29/#30/#52/#54): this needs real usage data the maintainer would have to supply; nothing to mechanically edit here without fabricating an observed effect. - The flagged openai.com RESEARCH.md link: re-verified via an independent fetch, still 403 (not 404) — consistent with bot/WAF blocking a non-browser client, not a confirmed dead link. Left as-is. --- CLAUDE.md | 2 +- README.md | 2 +- tests/test_check_docs.py | 4 +++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 58635ae..932b29d 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -72,4 +72,4 @@ Validate by running `/create-dev-loop` against any real repository you maintain | `CONTRIBUTING.md` | Restated conventions and the validation checklist still match this file (`CLAUDE.md`) | | `SECURITY.md` | The trust model still matches what Step 2 of `create-dev-loop.md` actually reads from the target repo | | `.github/PULL_REQUEST_TEMPLATE.md` | Doc-sync checkboxes and test-plan guidance match the current CI scope and this file (`CLAUDE.md`) | -| `.github/ISSUE_TEMPLATE/*.md` | Restated conventions and Step names still match this file (`CLAUDE.md`) | +| `.github/ISSUE_TEMPLATE/*.md` | Restated conventions and Step names still match this file (`CLAUDE.md`) — `config.yml` in the same directory has no restatable conventions and is outside this glob | diff --git a/README.md b/README.md index 537edc2..8645e12 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Register `create-dev-loop.md` itself as a slash command by symlinking it into `~ ``` mkdir -p ~/.claude/commands -ln -s "$(pwd)/create-dev-loop.md" ~/.claude/commands/create-dev-loop.md +ln -sf "$(pwd)/create-dev-loop.md" ~/.claude/commands/create-dev-loop.md ``` This is a one-time setup step for this repo's own product, distinct from Step 5, which registers each *generated* skill the same way. diff --git a/tests/test_check_docs.py b/tests/test_check_docs.py index 99840e8..3ce8d20 100644 --- a/tests/test_check_docs.py +++ b/tests/test_check_docs.py @@ -2,7 +2,9 @@ Each of check_docs.py's three checks appends to a module-level `errors` list rather than returning a value, so these tests reset that list before -each call and assert on its contents afterward. +each call and assert on its contents afterward. Any new test class added +here must do the same in its own setUp() — skipping the reset lets a +prior test's errors leak into the next assertion. """ import sys import unittest