add-release-note

Add a new release note entry. Keeps the client data file and the docs MDX page in sync, and bumps the version so the in-game modal re-appears for all players.

9 stars

Best use case

add-release-note is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Add a new release note entry. Keeps the client data file and the docs MDX page in sync, and bumps the version so the in-game modal re-appears for all players.

Teams using add-release-note should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/add-release-note/SKILL.md --create-dirs "https://raw.githubusercontent.com/cartridge-gg/nums/main/.agents/skills/add-release-note/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/add-release-note/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How add-release-note Compares

Feature / Agentadd-release-noteStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Add a new release note entry. Keeps the client data file and the docs MDX page in sync, and bumps the version so the in-game modal re-appears for all players.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# Add Release Note

Two files must **always** be updated together:

| File                               | Purpose                                       |
| ---------------------------------- | --------------------------------------------- |
| `client/src/data/release-notes.ts` | Structured data rendered in the in-game modal |
| `docs/pages/release-notes.mdx`     | Public documentation page                     |

## Steps

### 1. Add the entry in the data file

Open `client/src/data/release-notes.ts` and insert a new object **at the top** of the `RELEASE_NOTES` array:

```ts
{
  date: "April 11, 2026",          // human-readable date
  sections: [
    {
      title: "Features",            // or "Bug Fixes"
      items: [
        "Description of the change.",
      ],
    },
  ],
},
```

Every item must be a bullet point string in the `items` array. Group items under `"Features"` or `"Bug Fixes"` sections.

### 2. Bump the version

In the same file, update `RELEASE_NOTES_VERSION` to match the new entry date in ISO format:

```ts
export const RELEASE_NOTES_VERSION = "2026-04-11";
```

This is what triggers the modal to re-appear. The `useReleaseNotes` hook compares this value against the version stored in the player's localStorage (`nums-release-notes-version`). If they differ, the modal is shown.

### 3. Mirror in the docs

Open `docs/pages/release-notes.mdx` and add a matching section **at the top**, after the `---` separator:

```mdx
## April 11, 2026

### Features

- Description of the change.

---
```

Use the same section headings (`### Features`, `### Bug Fixes`) and the same bullet point text as in the data file.

## Checklist

- [ ] New entry added at the top of `RELEASE_NOTES` array
- [ ] `RELEASE_NOTES_VERSION` bumped to new date
- [ ] Matching entry added at the top of `docs/pages/release-notes.mdx`
- [ ] Bullet point text is identical in both files
- [ ] `pnpm run type:check` passes in `client/`

Related Skills

cairo-optimization

9
from cartridge-gg/nums

Improves Cairo performance after correctness is established, including hotspot profiling, arithmetic/loop optimization, and bounded-int hardening.

cairo-contract-authoring

9
from cartridge-gg/nums

Guides Cairo smart-contract authoring on Starknet with language fundamentals, safe structure choices, component composition, and implementation workflow references.

cairo-auditor

9
from cartridge-gg/nums

Systematic Cairo/Starknet security audit workflow with deterministic preflight, parallel vector specialists, adversarial reasoning, and strict false-positive gating.

account-abstraction

9
from cartridge-gg/nums

Starknet account abstraction correctness and security guidance for validate/execute paths, nonces, signatures, and session policies.

ui-ux-pro-max

9
from cartridge-gg/nums

UI/UX design intelligence for web and mobile. Includes 50+ styles, 161 color palettes, 57 font pairings, 161 product types, 99 UX guidelines, and 25 chart types across 10 stacks (React, Next.js, Vue, Svelte, SwiftUI, React Native, Flutter, Tailwind, shadcn/ui, and HTML/CSS). Actions: plan, build, create, design, implement, review, fix, improve, optimize, enhance, refactor, and check UI/UX code. Projects: website, landing page, dashboard, admin panel, e-commerce, SaaS, portfolio, blog, and mobile app. Elements: button, modal, navbar, sidebar, card, table, form, and chart. Styles: glassmorphism, claymorphism, minimalism, brutalism, neumorphism, bento grid, dark mode, responsive, skeuomorphism, and flat design. Topics: color systems, accessibility, animation, layout, typography, font pairing, spacing, interaction states, shadow, and gradient. Integrations: shadcn/ui MCP for component search and examples.

ui-architecture

9
from cartridge-gg/nums

UI component patterns for the Nums game client — Radix primitives, elements, containers, theming, Storybook conventions. Use when creating or modifying UI components, adding storybook stories, or working with the design system.

ui-architecture-icon

9
from cartridge-gg/nums

Add SVG icons to the Nums game client — convert SVG, create component, export, update storybook. Use when adding, modifying, or removing icon components.

shadcn

9
from cartridge-gg/nums

Manages shadcn components and projects — adding, searching, fixing, debugging, styling, and composing UI. Provides project context, component docs, and usage examples. Applies when working with shadcn/ui, component registries, presets, --preset codes, or any project with a components.json file. Also triggers for "shadcn init", "create an app with --preset", or "switch to --preset".

render-daily-replay

9
from cartridge-gg/nums

Auto-render a Remotion video replay of a Nums game on Mainnet. Resolves the target `gameId` from Torii (best reward of the day OR best score of the day, OR a specific gameId the user provides), silently auto-fetches the current NUMS price from Ekubo, then runs `pnpm remotion:render:game` with the right props. Use when the user asks to render today's top game, the daily winner, the biggest reward, the highest score, or any specific gameId, without having to assemble the render command by hand.

remotion-best-practices

9
from cartridge-gg/nums

Best practices for Remotion - Video creation in React

nums-remotion-replay

9
from cartridge-gg/nums

Project-specific skill for the Nums Remotion package that generates game replay videos by reusing the existing client React components. Covers the cross-package webpack setup, client-component overrides, Torii data fetching, font loading, render flow quirks, and hosting. Use when working on `remotion/` or the `SlidingNumber` component, adding new compositions, debugging font/animation issues, or setting up hosting for the Remotion Studio. Pairs with the generic `remotion-best-practices` skill.

dojo

9
from cartridge-gg/nums

Dojo Engine framework patterns — World, Systems, Models, Events, Components, Store, permissions, testing with spawn_test_world, and deployment with sozo.