Skip to content
Skills Library
Programming · Review & audit

ship-checklist

/ship-checklist

Definition-of-done checklist for shipping a new write, signal, table, edge, or query to the ax graph. Use when adding a SurrealDB table/edge/field, an ingest derive-stage, a new analytic query, or any new ax capability - before opening the PR. Ensures every write gets an on-demand read AND a proactive (agent-facing) read AND docs/distribution, not just the write. Triggers on "ship", "new signal", "new table/edge", "new lens/query", "wire this up", "is this done", or finishing an ax feature branch.

Repository
ax ↗
Licence
AGPL-3.0
Last repository change
07.10.2026

Assessment and security

90/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content25 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 07.10.2026, without references to retired models or APIs.

Licence

AGPL-3.0, copyleft: przeróbki udostępniane innym muszą mieć tę samą licencję.

What it does and when to use it

Definition-of-done checklist for shipping a new write, signal, table, edge, or query to the ax graph. Use when adding a SurrealDB table/edge/field, an ingest derive-stage, a new analytic query, or any new ax capability - before opening the PR. Ensures every write gets an on-demand read AND a proactive (agent-facing) read AND docs/distribution, not just the write. Triggers on "ship", "new signal", "new table/edge", "new lens/query", "wire this up", "is this done", or finishing an ax feature branch.

Triggers from the description

shipnew signalnew table/edgenew lens/querywire this upis this done
Original author description

Definition-of-done checklist for shipping a new write, signal, table, edge, or query to the ax graph. Use when adding a SurrealDB table/edge/field, an ingest derive-stage, a new analytic query, or any new ax capability - before opening the PR. Ensures every write gets an on-demand read AND a proactive (agent-facing) read AND docs/distribution, not just the write. Triggers on "ship", "new signal", "new table/edge", "new lens/query", "wire this up", "is this done", or finishing an ax feature branch.

How it works

  1. A. Write
  2. B. Read - on-demand
  3. C. Read - proactive (the usually-missed half)
  4. D. Documentation
  5. E. Onboarding / distribution
  6. F. Verify (evidence, not assertion)
  7. How to use
Original SKILL.md headings · 56 lines, 532 words
SKILL.md preview
---
name: ship-checklist
description: Definition-of-done checklist for shipping a new write, signal, table, edge, or query to the ax graph. Use when adding a SurrealDB table/edge/field, an ingest derive-stage, a new analytic query, or any new ax capability - before opening the PR. Ensures every write gets an on-demand read AND a proactive (agent-facing) read AND docs/distribution, not just the write. Triggers on "ship", "new signal", "new table/edge", "new lens/query", "wire this up", "is this done", or finishing an ax feature branch.
---

# ship-checklist - every write needs a read path an agent can find

The recurring miss in ax: we ship the **write + an on-demand CLI read**, and skip
the **proactive / agent-facing read**. A signal only visible on a manual CLI run
is invisible to the self-improvement loop. ax's whole thesis is that agents
discover and act on signals - so a new write is not done until an agent can find
it without being told.

Organizing rule: **every write needs (B) an on-demand read AND (C) a proactive
read AND an agent-facing surface (MCP/skill).** Most features do A+B and stop.

Run this before opening the PR. Skipping a row is fine - but say so in the PR and
why, don't skip silently.

## A. Write
- [ ] Schema in `schema.surql` + registered in `SCHEMA_TABLES` (CI mirror guard)
- [ ] Ingest idempotent + incremental (since-aware) + deref-free denormalization for reads (no record derefs inside aggregates - they hang prod)
- [ ] Backfill: does history get the signal, or only new data? Note "dark until re-ingest" if so
- [ ] Stage `deps` = every producer of the input table

## B. Read - on-demand
- [ ] CLI: a command or a facet on an existing one (consistent family)
- [ ] `--json` envelope for scripting
- [ ] Dashboard/studio surface (if visual)

## C. Read - proactive (the usually-missed half)
- [ ] **MCP tool** so an agent can query it in-context (`apps/axctl/src/mcp/tools.ts`)
- [ ] `ax improve recommend` generator - mint a proposal when the signal crosses a threshold (agent gets the suggestion unprompted)
- [ ] `ax insights` / dashboard next-actions wiring (if it implies an action)
- [ ] dojo agenda item (if the overnight loop should act on it)
- [ ] **Skill**: a cognitive pattern teaching an agent to *act* on the signal (e.g. the `ln` skill routes visual judgment to subagents off `ax cost images`)

## D. Documentation
- [ ] `CLAUDE.md` command/section docs (there is a docs gate for new subcommands)
- [ ] llms.txt / site docs / README, if user-facing
- [ ] CHANGELOG + release notes (release-please)
- [ ] Spec in `docs/superpowers/specs/` for non-trivial features

## E. Onboarding / distribution
- [ ] Onboarding prompt (`@ax/onboarding-prompt`) - should a day-1 user/agent know it exists?
- [ ] Marketing coverage (site page / blog / X), if a user-facing capability
- [ ] `/api/version` capability flag, if relevant

## F. Verify (evidence, not assertion)
- [ ] Tests: unit on pure helpers + schema-mirror guard + CLI command-list test
- [ ] Live-verified against the real DB - paste the actual output in the PR
- [ ] "Dark until data" honesty: state if it needs backfill/telemetry to light up

## How to use

Create a TodoWrite item per relevant row, or paste the A-F headers into the PR
body as a checked list. The point is the **C section** - if a new signal has no
MCP tool, no improve generator, and no skill, an agent will never surface it on
its own, and the feature is half-built no matter how clean the write is.

Versions

RepositoryScoreLicence
This page · Necmttn/ax90AGPL-3.0
AbrasiveUnit/ship-checklist87MIT

Identical content appears in 1 other GitHub folders. We show one copy with the highest score.

Database snapshot: 13.11.2026 · package version b3c868573cd6 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 90ax-add-ingest-stage
    Use when adding a new ingest stage or a new SurrealDB table to the ax graph. Encodes the exact registration gotchas that fail CI if missed.
  • 100surrealdb-js
    Using SurrealDB from JavaScript and TypeScript with the official surrealdb SDK, covering connecting (WebSocket/HTTP and embedded engines), authentication, CRUD, parameterized queries, and live queries. Use when connecting to SurrealDB from Node, Deno, Bun, or the browser, using…
  • 95surrealdb-python
    Using SurrealDB with the Python SDK, covering both client/server mode (WebSocket) and embedded mode (in-memory or file-based). Use when connecting to SurrealDB from Python, using the surrealdb Python package, running SurrealDB embedded without a server, or performing CRUD…
  • 100surrealdb
    Expert SurrealDB 3 skill. Use when working with SurrealDB, SurrealQL queries, multi-model data modeling (document, graph, vector, time-series, geospatial), schema design, graph traversal, vector search, security and permissions, deployment and operations, performance tuning, SDK…
  • 100adding-a-feature
    The four-area checklist every new feature must complete. Use when adding any feature, integration, or capability to ensure the agent and UI stay in parity.
  • 100create-release-checklist
    Generate a comprehensive release checklist when the user asks to prepare a release, create a release plan, or ship a version

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.