agentleFS
smileynetsmileynet/code-spice/AGENTS.md

code-spice

AGENTS.md0 starsChanged 9 months agoMITView on GitHub

This project uses bd (beads) for issue tracking. Run bd onboard to get started. Run the consolidated validation script: Or validate individual items manually: Each skill lives in skills/<skill-name>/SKILL.md with YAML frontmatter: Under 150 lines per SKILL.md. Focus on content that changes Claude's behavior — decision tables, checklists, severity frameworks, and operational protocols. See docs/skill-content-guide.md for content philosophy. The description field in frontmatter controls when Claude loads the skill. Include terms matching what users discuss during each Line Cook phase:

  • Commits and pushes

The file

We split this AGENTS.md into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Implement: Follow TDD — write test, make it pass, refactor

    line 19
  2. Distinctive:

    Verify: Run smoke tests (see below), check skill activates correctly

    line 20
  3. Distinctive:

    Run the consolidated validation script:

    line 26
  4. Distinctive:

    Avoid: prose explanations, before/after code examples, textbook knowledge, language conventions

    line 79
  5. Distinctive:

    File issues for remaining work: - Create issues for anything that needs follow-up

    line 107
  6. Distinctive:

    Verify: - All changes committed AND pushed

    line 118
  7. Distinctive:

    NEVER stop before pushing - that leaves work stranded locally

    line 123
  8. Distinctive:

    NEVER say "ready to push when you are" - YOU must push

    line 124
  9. Distinctive:

    If push fails, resolve and retry until it succeeds

    line 125

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md 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
AGENTS.md

Agent Instructions

This project uses bd (beads) for issue tracking. Run bd onboard to get started.

Quick Reference

bd ready              # Find available work
bd show <id>          # View issue details
bd update <id> --status in_progress  # Claim work
bd close <id>         # Complete work
bd sync               # Sync with git

Development Workflow

  1. Find work: bd ready to see unblocked tasks
  2. Claim it: bd update <id> --status in_progress
  3. Implement: Follow TDD — write test, make it pass, refactor
  4. Verify: Run smoke tests (see below), check skill activates correctly
  5. Close: bd close <id> with semantic context comment
  6. Push: bd sync && git push

Smoke Testing

Run the consolidated validation script:

bash tests/smoke/validate.sh

Or validate individual items manually:

# Plugin structure
test -f .claude-plugin/plugin.json && echo "OK: plugin.json exists"
python3 -c "import json; json.load(open('.claude-plugin/plugin.json'))" && echo "OK: valid JSON"

# Skill validation (replace <skill-name>)
test -f skills/<skill-name>/SKILL.md && echo "OK: SKILL.md exists"
head -1 skills/<skill-name>/SKILL.md | grep -q "^---" && echo "OK: has frontmatter"

Local Development Install

/plugin marketplace add /home/sam/code/code-spice

Skill Authoring Conventions

File Structure

Each skill lives in skills/<skill-name>/SKILL.md with YAML frontmatter:

---
name: <skill-name>
description: <keyword-rich description that triggers activation during Line Cook phases>
---

Naming

  • Prefix skill directories with code- (e.g., code-readability, code-antipatterns)
  • Exceptions: software-tradeoffs, refactoring-patterns, and error-handling-patterns use their domain name directly

Size Target

Under 150 lines per SKILL.md. Focus on content that changes Claude's behavior — decision tables, checklists, severity frameworks, and operational protocols. See docs/skill-content-guide.md for content philosophy.

Content Patterns

  • Decision tables and checklists as primary content (token-efficient behavioral anchors)
  • Severity classifications for consistent output across sessions
  • Empirical data with sources (statistics Claude won't cite unprompted)
  • Operational protocols with named stages (e.g., SCARF)
  • Current tool knowledge that may post-date training cutoff
  • Avoid: prose explanations, before/after code examples, textbook knowledge, language conventions

Keyword Activation

The description field in frontmatter controls when Claude loads the skill. Include terms matching what users discuss during each Line Cook phase:

PhaseExample Keywords
/brainstormquality, tradeoffs, design decisions
/scopereadability, naming, error handling, antipatterns
/cookrefactoring, testing, implementation
/plan-auditantipatterns, plan quality, audit
/servecode review, feedback

Command Authoring

Commands live in commands/<name>.md with YAML frontmatter specifying name, description, and allowed-tools. They provide interactive workflows that reference skill knowledge.

Agent Authoring

Agents live in agents/<name>.md with YAML frontmatter specifying name, description, and tools. Agents act as subagents during Line Cook phases (e.g., /line:serve).

Landing the Plane (Session Completion)

When ending a work session, you MUST complete ALL steps below. Work is NOT complete until git push succeeds.

MANDATORY WORKFLOW:

  1. File issues for remaining work - Create issues for anything that needs follow-up
  2. Run quality gates (if code changed) - Tests, linters, builds
  3. Update issue status - Close finished work, update in-progress items
  4. PUSH TO REMOTE - This is MANDATORY:
    git pull --rebase
    bd sync
    git push
    git status  # MUST show "up to date with origin"
  5. Clean up - Clear stashes, prune remote branches
  6. Verify - All changes committed AND pushed
  7. Hand off - Provide context for next session

CRITICAL RULES:

  • Work is NOT complete until git push succeeds
  • NEVER stop before pushing - that leaves work stranded locally
  • NEVER say "ready to push when you are" - YOU must push
  • If push fails, resolve and retry until it succeeds

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.