From d0e37b8b9143d8e5ce23467597a7e73d5d30ddb2 Mon Sep 17 00:00:00 2001 From: Erich Blume Date: Tue, 3 Feb 2026 19:06:14 -0800 Subject: [PATCH] Fix towncrier fragment format: use flat ..md The towncrier config uses the type's `directory` field as the type identifier in filenames, NOT as subdirectories. Correct format: docs/changelog.d/..md NOT: docs/changelog.d//.md - Move fragments to root with type suffix - Remove empty type subdirectories - Fix CLAUDE.md instructions - Fix tutorial examples in contributing.md and ai-assistance-guide.md Co-Authored-By: Claude Opus 4.5 --- CLAUDE.md | 8 ++++---- ...onfirm.md => +container-tag-no-confirm.misc.md} | 0 ...-deploy-docs.md => auto-deploy-docs.feature.md} | 0 docs/tutorials/ai-assistance-guide.md | 4 ++-- docs/tutorials/contributing.md | 14 +++++++------- 5 files changed, 13 insertions(+), 13 deletions(-) rename docs/changelog.d/{misc/+container-tag-no-confirm.md => +container-tag-no-confirm.misc.md} (100%) rename docs/changelog.d/{feature/auto-deploy-docs.md => auto-deploy-docs.feature.md} (100%) diff --git a/CLAUDE.md b/CLAUDE.md index 42287d1..d15fb77 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -37,13 +37,13 @@ Address each unresolved comment before proceeding. The user will resolve comment 4. When making changes, add a towncrier changelog fragment. Use the branch name as the identifier when possible, or use orphan (`+`) otherwise: ```bash - # Using subdirectory (preferred) - type is the directory name - echo "Add new feature X" > docs/changelog.d/feature/new-feature.md + # Using branch name (preferred) + echo "Add new feature X" > docs/changelog.d/new-feature.feature.md # Orphan fragment (when no branch name fits) - echo "Fix bug Y" > docs/changelog.d/bugfix/+fix-bug-y.md + echo "Fix bug Y" > docs/changelog.d/+fix-bug-y.bugfix.md ``` - Fragment types (use as directory name): `feature`, `bugfix`, `infra`, `doc`, `misc`. Fragments are collected into CHANGELOG.md during releases. + Fragment types: `feature`, `bugfix`, `infra`, `doc`, `misc`. Fragments are collected into CHANGELOG.md during releases. 5. Use `Brewfile` and `mise.toml` to install tools needed on the development workstation (typically hostnamed "gilbert", username "eblume"). diff --git a/docs/changelog.d/misc/+container-tag-no-confirm.md b/docs/changelog.d/+container-tag-no-confirm.misc.md similarity index 100% rename from docs/changelog.d/misc/+container-tag-no-confirm.md rename to docs/changelog.d/+container-tag-no-confirm.misc.md diff --git a/docs/changelog.d/feature/auto-deploy-docs.md b/docs/changelog.d/auto-deploy-docs.feature.md similarity index 100% rename from docs/changelog.d/feature/auto-deploy-docs.md rename to docs/changelog.d/auto-deploy-docs.feature.md diff --git a/docs/tutorials/ai-assistance-guide.md b/docs/tutorials/ai-assistance-guide.md index a46dd65..fd67968 100644 --- a/docs/tutorials/ai-assistance-guide.md +++ b/docs/tutorials/ai-assistance-guide.md @@ -54,10 +54,10 @@ EOF Add a fragment for user-visible changes: ```bash -echo "Description" > docs/changelog.d/feature/branch-name.md +echo "Description" > docs/changelog.d/branch-name.feature.md ``` -Types (directory names): `feature`, `bugfix`, `infra`, `doc`, `misc` +Types (file suffix): `.feature`, `.bugfix`, `.infra`, `.doc`, `.misc` ## Service Locations diff --git a/docs/tutorials/contributing.md b/docs/tutorials/contributing.md index bee69b8..f0fd48c 100644 --- a/docs/tutorials/contributing.md +++ b/docs/tutorials/contributing.md @@ -95,15 +95,15 @@ Depending on what you're changing: For user-visible changes: ```bash -echo "Description of your change" > docs/changelog.d/feature/your-branch.md +echo "Description of your change" > docs/changelog.d/your-branch.feature.md ``` -Fragment types (use as directory name): -- `feature/` - New functionality -- `bugfix/` - Bug fixes -- `infra/` - Infrastructure changes -- `doc/` - Documentation -- `misc/` - Other +Fragment types (file suffix): +- `.feature.md` - New functionality +- `.bugfix.md` - Bug fixes +- `.infra.md` - Infrastructure changes +- `.doc.md` - Documentation +- `.misc.md` - Other ### 4. Test Your Changes