From 9c1acd32c42f49c3b9c8a5b0c0890e8f2ae2e13a Mon Sep 17 00:00:00 2001 From: Alex-Wengg Date: Fri, 25 Sep 2026 15:00:40 -0400 Subject: [PATCH] docs(claude): issue <-> code <-> HF traceability convention for model uploads Co-Authored-By: Claude Opus 5.5 (1M context) --- CLAUDE.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index 86a3f3c48..39135a293 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -26,6 +26,12 @@ FluidAudio is a Swift framework for local, low-latency audio processing on Apple - Uploading models, datasets, and files to HuggingFace is allowed - Creating HuggingFace repos is allowed - Confirm the target repo with the user before uploading +- **Traceability** (issue ↔ code ↔ HF): every model fix/upload must be linkable both ways + - Ship fixed models under a new name (`Foo_v2.mlmodelc`) next to the original; never overwrite in place + - HF commit message names the issue: `... (FluidAudio #NNN)`; pass `--commit-description` with the mobius/FluidAudio PR links + - mobius and FluidAudio PR bodies link the issue, each other, and the full HF commit URL + - Add a row to the HF model card's `## Changelog` table (date, files, change, issue, mobius PR, FluidAudio PR, HF commit); create the section if missing + - The Swift `ModelNames` comment for a renamed file cites the issue number ### MODEL OPERATIONS - CONSULT BEFORE IMPLEMENTING