From c036562dfe029f241978c4791765ca6a1fb0244a Mon Sep 17 00:00:00 2001 From: Erich Blume Date: Tue, 3 Feb 2026 18:59:30 -0800 Subject: [PATCH] Fix towncrier fragment naming and CLAUDE.md instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fragments in subdirectories should be named `.md`, not `..md` - the type is already indicated by the directory. - Rename feature/auto-deploy-docs.feature.md → feature/auto-deploy-docs.md - Rename misc/+container-tag-no-confirm.misc.md → misc/+container-tag-no-confirm.md - Update CLAUDE.md with correct fragment path format Co-Authored-By: Claude Opus 4.5 --- CLAUDE.md | 8 ++++---- ...-deploy-docs.feature.md => auto-deploy-docs.md} | 0 ...onfirm.misc.md => +container-tag-no-confirm.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/feature/{auto-deploy-docs.feature.md => auto-deploy-docs.md} (100%) rename docs/changelog.d/misc/{+container-tag-no-confirm.misc.md => +container-tag-no-confirm.md} (100%) diff --git a/CLAUDE.md b/CLAUDE.md index 5fccec6..42287d1 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 branch name (preferred) - echo "Add new feature X" > docs/changelog.d/feature/new-feature.feature.md + # Using subdirectory (preferred) - type is the directory name + echo "Add new feature X" > docs/changelog.d/feature/new-feature.md # Orphan fragment (when no branch name fits) - echo "Fix bug Y" > docs/changelog.d/+fix-bug-y.bugfix.md + echo "Fix bug Y" > docs/changelog.d/bugfix/+fix-bug-y.md ``` - Fragment types: `feature`, `bugfix`, `infra`, `doc`, `misc`. Fragments are collected into CHANGELOG.md during releases. + Fragment types (use as directory name): `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/feature/auto-deploy-docs.feature.md b/docs/changelog.d/feature/auto-deploy-docs.md similarity index 100% rename from docs/changelog.d/feature/auto-deploy-docs.feature.md rename to docs/changelog.d/feature/auto-deploy-docs.md diff --git a/docs/changelog.d/misc/+container-tag-no-confirm.misc.md b/docs/changelog.d/misc/+container-tag-no-confirm.md similarity index 100% rename from docs/changelog.d/misc/+container-tag-no-confirm.misc.md rename to docs/changelog.d/misc/+container-tag-no-confirm.md diff --git a/docs/tutorials/ai-assistance-guide.md b/docs/tutorials/ai-assistance-guide.md index 3c49b60..a46dd65 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/branch-name.feature.md +echo "Description" > docs/changelog.d/feature/branch-name.md ``` -Types: `feature`, `bugfix`, `infra`, `doc`, `misc` +Types (directory names): `feature`, `bugfix`, `infra`, `doc`, `misc` ## Service Locations diff --git a/docs/tutorials/contributing.md b/docs/tutorials/contributing.md index d65ed23..bee69b8 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/your-branch.feature.md +echo "Description of your change" > docs/changelog.d/feature/your-branch.md ``` -Fragment types: -- `.feature.md` - New functionality -- `.bugfix.md` - Bug fixes -- `.infra.md` - Infrastructure changes -- `.doc.md` - Documentation -- `.misc.md` - Other +Fragment types (use as directory name): +- `feature/` - New functionality +- `bugfix/` - Bug fixes +- `infra/` - Infrastructure changes +- `doc/` - Documentation +- `misc/` - Other ### 4. Test Your Changes