rajdeepratanrajdeepratan/SlashForge/.claude/skills/add-guide-file/SKILL.md

add-guide-file

Skill5 starsChanged 37 days agoMITView on GitHub

Add a new slashforge-* guide template to the kit — use when creating a new workflow/reference guide that agents read, wiring it into the installer, and regenerating the render snapshot

In this repository3 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- docs/CLAUDE.mdCLAUDE.md
- add-commandSkill

The file

We split this skill into the rules it gives an agent

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

≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
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

Very specific:
Read .claude/rules/templates.md (authoring rules) and .claude/rules/cli.md (installer conventions).
line 16
Very specific:
Register it in the installer: Add the filename to the GUIDE_FILES array in bin/install.js (keep it near related guides).
line 23

≈ “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.

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

Files

SKILL.md

Add a guide file

A "guide" is a templates/slashforge-*.md reference that is installed next to the commands and read by agents at runtime (e.g. slashforge-workflow-verify.md). This recipe adds one and wires it so the installer actually ships it.

Before starting

Read .claude/rules/templates.md (authoring rules) and .claude/rules/cli.md (installer conventions).

Steps

Create the file at templates/slashforge-<name>.md. Start with YAML frontmatter (name, description) and keep the body ≤ 200 lines. If it would run longer, split it and link a sibling guide.
Use per-host target blocks for any host-specific wording — balanced … / …. Valid names: claude, agents, cursor, codex, neutral.
Register it in the installer. Add the filename to the GUIDE_FILES array in bin/install.js (keep it near related guides). An unregistered guide is never installed.
Reference it from whatever guide or command loads it (e.g. a workflow.md "companion files" list). A guide nothing points to is dead weight.
Run the tests — npm test. Frontmatter, line-limit, and target-block checks run here.
Regenerate the Claude render snapshot (the pinned-render test will otherwise fail, by design):
```
node scripts/snapshot-claude-render.js
git diff test/fixtures/claude-render
```
Review the diff: the new guide should appear, and nothing unrelated should change.
Update CHANGELOG.md under ## [Unreleased] describing the new guide.

Verify

File is ≤ 200 lines with valid frontmatter
Every  has a matching ; all target names are valid
Filename added to GUIDE_FILES in bin/install.js
At least one existing guide/command references the new file
npm test passes
test/fixtures/claude-render regenerated and the diff reviewed
CHANGELOG.md updated

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.

Check your setup, free