Skip to content

docs: issue ↔ code ↔ HF traceability convention for model uploads #964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Alex-Wengg merged 1 commit into from
Sep 25, 2026
Merged

docs: issue ↔ code ↔ HF traceability convention for model uploads #964

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading