Skip to content

Document install step; add ISSUE_TEMPLATE to doc sources table - #102

Merged
dmccoystephenson merged 2 commits into
mainfrom
fix/oss-readiness-followups
Aug 3, 2026
Merged

Document install step; add ISSUE_TEMPLATE to doc sources table#102
dmccoystephenson merged 2 commits into
mainfrom
fix/oss-readiness-followups

Conversation

@dmccoystephenson

@dmccoystephenson dmccoystephenson commented Aug 3, 2026

Copy link
Copy Markdown
Member

Summary

Must-fix (from the public-readiness review):

Nice-to-have, folded in:

Not included: #98 (delete 13 stale, already-squash-merged branches) — confirmed all 11 currently-stale branches (2 named in the original issue are already gone) are MERGED via gh pr list, but the branch-deletion push was blocked by this environment's auto-mode classifier as a destructive/shared-repo action. Left for the maintainer to run directly:

git push origin --delete feature/add-research-md feature/localization-and-command-sub-fixes feature/rubric-based-self-review fix/doc-accuracy-sweep fix/gh-pr-create-restricted-fetch-refspec fix/no-build-system-guidance fix/research-md-pr54-implementations fix/sandbox-blocks-directory-creation fix/scratch-dir-and-revert-checkpoint fix/step1-update-scratch-file license-mit

Doc sync check

  • README.md's "What it does" Step list still matches create-dev-loop.md's Steps 1:1 (unchanged — Installation and the new TOC are outside the Step list)
  • Every {{placeholder}} added or changed has a corresponding Step 4 substitution-table row — n/a, no placeholders touched
  • RESEARCH.md updated — n/a, no template/phase behavior change

Test plan

  • python3 scripts/check_docs.py passes.
  • python3 -m unittest discover -s tests -v — 13/13 new tests pass.
  • Manually verified the symlink command in the Installation section matches the actual convention already in use (~/.claude/commands/create-dev-loop.md -> .../create-dev-loop.md) and how Step 5 registers generated skills.
  • Verified the pinned action SHAs (actions/checkout@11d5960a... = v4.4.0, actions/setup-python@a26af69b... = v5.6.0) resolve to the tagged commits via gh api.
  • Verified all 11 branches proposed for deletion show MERGED via gh pr list --state all --head <branch>.

🤖 Generated with Claude Code

README never explained how to register create-dev-loop.md itself as
a slash command, leaving first-time visitors with no way to actually
invoke /create-dev-loop. CLAUDE.md's doc sources-of-truth table also
omitted .github/ISSUE_TEMPLATE/*.md, which restates the same
conventions as PULL_REQUEST_TEMPLATE.md and can drift the same way.

Closes #96, closes #81
…README

- tests/test_check_docs.py: fixture-based unit tests for check_docs.py's
  three checks, wired into CI, so a silently-broken check doesn't read as
  "0 errors -> pass". Closes #97.
- create-dev-loop.md: add a "Steps at a glance" anchor-link TOC — Step 3
  and Step 4 sit ~450 lines apart with a lot of example content between.
  Closes #99.
- .github/workflows/ci.yml: pin actions/checkout and actions/setup-python
  to commit SHAs instead of major-version tags. Closes #100.
- scripts/README.md: one-line pointer to CLAUDE.md/CONTRIBUTING.md.
  Closes #101 (no CHANGELOG added — fine to skip pre-1.0, per the same
  issue).
@dmccoystephenson
dmccoystephenson merged commit 723b3c2 into main Aug 3, 2026
1 check passed
@dmccoystephenson
dmccoystephenson deleted the fix/oss-readiness-followups branch August 3, 2026 06:01
dmccoystephenson added a commit that referenced this pull request Aug 3, 2026
* Document install step and add ISSUE_TEMPLATE to doc sources table

README never explained how to register create-dev-loop.md itself as
a slash command, leaving first-time visitors with no way to actually
invoke /create-dev-loop. CLAUDE.md's doc sources-of-truth table also
omitted .github/ISSUE_TEMPLATE/*.md, which restates the same
conventions as PULL_REQUEST_TEMPLATE.md and can drift the same way.

Closes #96, closes #81

* Fold in nice-to-have readiness items: tests, TOC, pinned CI, scripts README

- tests/test_check_docs.py: fixture-based unit tests for check_docs.py's
  three checks, wired into CI, so a silently-broken check doesn't read as
  "0 errors -> pass". Closes #97.
- create-dev-loop.md: add a "Steps at a glance" anchor-link TOC — Step 3
  and Step 4 sit ~450 lines apart with a lot of example content between.
  Closes #99.
- .github/workflows/ci.yml: pin actions/checkout and actions/setup-python
  to commit SHAs instead of major-version tags. Closes #100.
- scripts/README.md: one-line pointer to CLAUDE.md/CONTRIBUTING.md.
  Closes #101 (no CHANGELOG added — fine to skip pre-1.0, per the same
  issue).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment