Skip to content

AGENTS.md

Latest commit

 

History

History
30 lines (23 loc) · 1.07 KB

AGENTS.md

File metadata and controls

30 lines (23 loc) · 1.07 KB
Raw

Repository guide for agents

This repo packages the runbook Agent Skill for distribution across Cursor, Claude Code, Claude Web, and Claude Cowork.

Layout

  • skills/runbook/SKILL.md — the skill itself (source of truth).
  • release-please-config.json, .release-please-manifest.json, version.txt — release automation via release-please + Conventional Commits.
  • .github/workflows/validate.yml — validates the skill on PRs/pushes.
  • .github/workflows/release.yml — cuts releases and uploads runbook.skill.

Conventions

  • Use Conventional Commits (feat:, fix:, docs:, ...). feat/fix bump the version; merging the release PR publishes runbook.skill to a GitHub Release.
  • Keep the description in skills/runbook/SKILL.md <= 200 chars so it uploads to Claude Web/Cowork.
  • The version line in SKILL.md carries # x-release-please-version so release-please updates it in place.

Commands

  • npx skillship@latest validate --profile all
  • npx skillship@latest package
  • npx skillship@latest install runbook -a cursor -a claude-code