updating-artifact-schema
Skill45 starsChanged 26 days agoMITView on GitHub
Use whenever changing the schema of a persistent artifact, including config files, transcripts, caches, checkpoints, credential metadata, or other data read across software versions.
In this repository6 other files it gives its agents.
- AGENTS.mdAGENTS.md
- announce-kit-releaseSkill
- release-notesSkill
- secure-rust-dependency-changesSkill
- shared-stateSkill
- user-docsSkill
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 11
Add one migration per schema change.
- Distinctive: line 13
Test legacy and current shapes, mixed-key conflicts, malformed values, and writer output.
- Distinctive: line 14
Follow repository release rules, then run the smallest relevant format, test, and lint checks.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Updating Artifact Schemas
- Inspect every reader, writer, strict parser, test, and historical shape before editing.
- For hand-written artifacts, prefer ordered, shape-driven, idempotent migrations without a required version key. Use explicit versions only when shapes cannot be distinguished safely.
- Parse into a generic representation, run all migrations in order, then strictly deserialize the latest shape.
- Add one migration per schema change; never rewrite an older migration. Preserve the new value when old and new fields coexist.
- Make every writer emit only the latest shape. Do not rewrite user-owned files on read unless explicitly required.
- Test legacy and current shapes, mixed-key conflicts, malformed values, and writer output.
- Follow repository release rules, then run the smallest relevant format, test, and lint checks.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.