agentleFS
CoreBunchCoreBunch/Instatic/.agents/skills/maintain/SKILL.md

maintain

Skill9.1k starsChanged todayMITView on GitHub

What every change to Instatic owes the codebase beyond the code itself. Which docs to read before touching an area, which doc must be updated when you change it, which registries (E2E feature matrix, architecture tests) must be kept in step, and what "done" means here. Read this before starting any fix, feature, or refactor in Instatic, and again before opening the PR to check nothing was left behind. Companion to run-and-test, which covers booting and testing the project, and release, which builds the changelog from merged PRs when a release is prepared.

22 other projects use a version of this.

Trending

Less talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 0 mentionsApr 2026: 0 mentionsMay 2026: 0 mentionsJun 2026: 2 mentionsJul 2026: 10 mentionsAug 2026: 2 mentionsSep 2026: 2 mentionsOct 2026: 0 mentionsNov 2026: 2 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the CoreBunch/Instatic repository that our weekly crawl found. There is no adoption data for this file yet.

Most recently taken up by

Who's talking about CoreBunch/Instatic

The biggest 5 of 18 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 18

Talked about on GitHub, Bluesky and Hacker News (18 times).

On GitHub · 12

7 more on GitHub

On Bluesky · 5

On Hacker News · 1

Used with

Projects with it also use ship.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • AWSSkill

    ship

    Finalize dev work on an issue branch — update docs, push, and open a PR.

    Also in 3 projects that use this

  • Other versions22 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 22

    1. garrytan/gbrain★ 33ksame name
    2. slopus/happy★ 25ksame name
    3. PhilipK/BoilR★ 1.9ksame name
    4. GlassHaven/Haven★ 1.4ksame name
    5. GlassOnTin/Haven★ 1.4ksame name
    6. iovisor/ubpf★ 996same name
    7. everruns/bashkit★ 325same name
    8. devantler-tech/ksail★ 164same name
    9. exmergo/dex★ 132same name
    10. inoio/agents-sandbox★ 89same name

    12 more not listed

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository4 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 21 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read this before starting a change, not after.

    line 8
  2. Very specific:

    Keep CHANGELOG.md out of every PR except the release-preparation PR.

    line 49
  3. Very specific:

    Use run-and-test for the gate.

    line 62
  4. Distinctive:

    Every doc describing what you changed is updated in the same change.

    line 68

“Common” is measured: kept by at least 6 in 10 of the 21 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Maintaining Instatic

Read this before starting a change, not after. Half of what it asks for is cheaper to do while the code is fresh than to reconstruct later.

run-and-test covers booting, driving and testing the project. This skill covers everything else a change owes: docs, registries, gates.

Read before you change

CLAUDE.md at the root is the rulebook and wins over everything. Then read the doc for the area you are touching. Instatic's docs are genuinely accurate, so reading first is faster than reverse-engineering.

You are touchingRead first
Anything, for orientationdocs/architecture.md
Admin or editor UIdocs/editor.md, docs/design.md
Server, routing, handlersdocs/server.md
Publishing, baked output, cachesdocs/features/publisher.md
Content or data workspacesdocs/features/content-workspace.md, docs/features/data-workspace.md
Plugins, sandbox, manifestsdocs/features/plugin-system.md
AI, agent, MCPdocs/features/agent.md, docs/features/mcp-connectors.md
Page tree, mutations, nodesdocs/reference/page-tree.md
DB access or migrationsdocs/reference/database-dialects.md
Validation at a boundarydocs/reference/typebox-patterns.md
Shared UI primitivesdocs/reference/ui-primitives.md
Hooks and memoizationdocs/reference/react-compiler.md
A structural gate testdocs/reference/architecture-tests.md

docs/README.md is the index when the table above does not cover it.

Update the doc in the same change

A doc that describes what you just changed is now wrong. Fix it in the same commit. Not a follow-up, not a TODO. These docs are trusted precisely because they have stayed accurate.

docs/CONVENTIONS.md is the meta-doc and governs how to write them. Its rules in short:

  • Two readers, in this order: coding agents, then humans skimming. Agents need concrete file paths, code shapes, and invariants.
  • If a sentence does not help one of those two make a decision or correct a misunderstanding, delete it.
  • Three doc types, and the folder decides which: top-level docs/*.md (system-wide, long-lived, rare additions, propose before adding), docs/features/*.md (one per user-recognisable capability), docs/reference/*.md (rules and patterns).
  • Docs describe what exists, never what is planned, considered, or in flight. In-flight work belongs in docs/plans/.

Adding a whole new top-level doc is a decision, not a reflex. Propose it rather than creating one.

Release notes are release work

Keep CHANGELOG.md out of every PR except the release-preparation PR. A feature or fix PR's existence does not guarantee that it will land in the next release.

The release skill owns the changelog. When preparing a release, it derives the release section from the PRs actually merged since the latest release tag.

Registries that must stay in step

  • New E2E coverage — register in docs/e2e/feature-matrix.md (row plus a note saying what the spec actually drives) and docs/e2e/feature-validation.tsv (14 columns). Next free ID in the family: CONTENT-, ADMIN-, AI-, DASH-.
  • A moved structural boundary — the gate tests in src/__tests__/architecture/ are the rule, not a suggestion. When your change legitimately moves a boundary, update the gate test in the same change and explain why in the PR. Never weaken a gate to make a diff pass.
  • A new allowlist entry — several gates carry allowlists with § justifications (button-primitive-usage.test.ts, boundary-validation.test.ts). Adding an entry means writing its justification.
  • A schema change — a new additive migration in both migrations-pg.ts and migrations-sqlite.ts with the same ID and the same semantic effect. Live installations run the migration runner on every pull, so nothing destructive, and never rewrite a committed migration.

Verify

Use run-and-test for the gate. Run it once at the end, and read the exit codes rather than piping them into tail.

Done means

  1. The code works and you have watched it work.
  2. The gate passes, run per run-and-test, with exit codes read directly.
  3. Every doc describing what you changed is updated in the same change.
  4. CHANGELOG.md is unchanged; the release-preparation PR owns release notes.
  5. Any registry your change touches is updated: E2E matrix, architecture gate, allowlist, migrations.
  6. Anything you could not verify is stated plainly in the PR rather than glossed over.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.