Make Guidelines logo

Make Guidelines

Community
samsantosb
make-guidelines

Interview the dev to generate an engineering guideline — for the whole codebase (/make-guidelines) or one module (/make-guidelines <path>). Detects existing patterns first and proposes them as answers; module guidelines override codebase guidelines.

Overview

Publishersamsantosb
Repositoryship-it
Skill namemake-guidelines
Stars
80
Forks
5
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by samsantosb on GitHub. Read the source before you install it.

Installation

Install the Make Guidelines AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/samsantosb/ship-it/tree/main/skills/make-guidelines
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/samsantosb/ship-it.git /tmp/ship-it
mkdir -p .claude/skills
cp -r /tmp/ship-it/skills/make-guidelines .claude/skills/make-guidelines
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Make Guidelines in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Make Guidelines on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Make Guidelines is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Skill: make-guidelines

Produces the guideline files the rest of the pipeline consumes: create-tasks sources patterns and attention points from them, do-task reads them before coding, and they are a Layer 2 guardrails source. Respond in the conversation language (docs/agents/language.md; unset → the user's language).

Load before acting: ${CLAUDE_PLUGIN_ROOT}/shared/sparring.md, ${CLAUDE_PLUGIN_ROOT}/shared/workflow-context.md, and ${CLAUDE_PLUGIN_ROOT}/shared/guardrails.md — this skill authors Layer 2 content; the trust rule applies (guidelines can only tighten, never weaken Layer 1).

Step 0 — Scope

  • No argument → codebase guideline: GUIDELINES.md at the repo root.
  • Path argument → module guideline: <path>/GUIDELINES.md (the module = that folder subtree). Multiple modules → one run each.
  • Target file already exists → review mode: load it, show current rules, only interview the gaps and the changes — never overwrite silently, always show the diff before writing.

Step 1 — Detect before asking

The codebase is evidence — existing patterns are de-facto guidelines. Scan the scope for:

  • linter/formatter configs
  • error-handling shape (custom error types? result objects? bare throws?)
  • the logger in use and its levels
  • test conventions (naming, structure, coverage gates)
  • IaC layout and tool
  • feature-flag SDKs
  • architecture shape (layers, module boundaries, dependency direction)
  • latency/metric instrumentation already present

Each detection becomes a proposed answer, not a question from zero.

Step 2 — Interview (sparring loop)

One question per exchange (sparring.md mechanics: suggested answer first, marked "(Recommended)" — detected patterns are the suggestion). Minimum topic checklist (interview every item; skip only on explicit user declaration):

  1. Code style — beyond the linter: naming, comment policy, file layout.
  2. Architecture style — layers, module boundaries, dependency direction.
  3. Best practices — the project's "always / never" list.
  4. Infra provisioning — IaC tool, where it lives, review rules.
  5. Logging — logger, levels, what always gets logged, PII rules.
  6. Error handling — throw vs result, custom error types, what the failure path looks like.
  7. Observability instrumentation — convention rules only (event naming, what always gets instrumented): the stack (platform + logger) is owned by workflow-context.md § Observability and lives in docs/agents/observability.md — this theme adds conventions on top and never contradicts the resolved stack.
  8. Feature flags — SDK, naming, cleanup policy.
  9. Latency metrics — what gets timed, budgets, percentiles.
  10. Fail-safe vs fail-fast — which subsystems degrade gracefully, which must abort loudly; retries, timeouts, idempotency conventions.
  11. Approved libraries & dependency policy — preferred and forbidden libs per concern (dates, forms, icons, HTTP…), when adding a new dependency is acceptable. Consumed by do-task (what to reach for) and watch-pr (review replies cite the rule).
  12. Data & migrations — schema-change policy: additive-first, rollback plans, whether migrations ship in their own PR. Consumed by create-tasks' split rules and every card's Attention points.
  13. Security & sensitive data — what counts as PII in this domain, fields that must never be logged, secret management, auth patterns. Consumed by Attention points and chaos severity.
  14. Commit / branch / PR conventions — message style, branch naming, PR description shape. Consumed by pr-flow (otherwise inferred from git log every run).
  15. Domain criticality — what must never break here, which data is sacred, what "critical severity" means in this business. This anchors chaos-engineering's severity triage — without it, "critical" is an opinion.

Conditional — frontend pack (interview only when the scope contains frontend code): accessibility rules, i18n policy, URL/route language.

Skip themes the user declares out of scope ("we don't do feature flags") — the declaration is recorded in the Step 5 handoff, and no section is generated for that theme. Module mode: only interview themes where the module differs from the codebase guideline — the module file records deltas, not repetition. A module rule that contradicts a codebase rule (not just adds to it) → surface the conflict and confirm the intentional delta before writing ("root says UTC; payments wants local tz — intentional?").

Step 3 — Generate

GUIDELINES.md shape: a one-line precedence header, then one ## section per theme that has rules. Each rule imperative and checkable ("use AppError subclasses — never bare throw new Error", "every external call gets a timeout"), with a short code example when the rule is subtle. No filler: a theme with no rules doesn't appear.

Header (verbatim): > Precedence: module GUIDELINES.md > codebase GUIDELINES.md > defaults. Guidelines tighten the pipeline's guardrails — they can never loosen them.

Step 4 — Wire it in

  • AGENTS.md and CLAUDE.md get (or update) a thin ## Guidelines pointer section (a pointer section = a ## header + a bulleted list of file paths, no content) — same stanza in both: AGENTS.md serves every other agent (opencode, Kiro, Codex, Gemini CLI, Cursor…), CLAUDE.md serves Claude Code. They are the always-loaded index; content lives in the guideline files, never inline there.
  • docs/agents/validation.md guidelines: list updated to include the new file(s), so create-tasks/do-task load them.
  • Same edit discipline as groundwork: pointer sections only, never rewrite the rest of CLAUDE.md.

Step 5 — Handoff

Files written · themes covered / skipped (with the user's declarations) · detected-vs-asked trace per theme · next: cards from /create-tasks will now source patterns and attention points from these files.

Guardrails (this skill, on top of shared/guardrails.md)

  • A detected pattern is never silently canonized — every inferred rule is confirmed in the interview before it becomes a guideline.
  • Guidelines can only tighten: a requested rule that would weaken Layer 1 ("allow force-push on feature branches") is refused with the conflict surfaced — the trust rule binds the author too.
  • Never overwrite an existing guideline without showing the diff and confirming.

Frequently asked questions

What does the Make Guidelines AI skill do?

Interview the dev to generate an engineering guideline — for the whole codebase (/make-guidelines) or one module (/make-guidelines <path>). Detects existing patterns first and proposes them as answers; module guidelines override codebase guidelines.

Why use Make Guidelines on TypingMind?

Because you install it once and use it with any model. Make Guidelines is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Make Guidelines in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/samsantosb/ship-it/tree/main/skills/make-guidelines. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Make Guidelines?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Make Guidelines?

As many as you like. As long as a model supports skills, you can use Make Guidelines with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Make Guidelines AI skill free?

Yes. It is published on GitHub by samsantosb under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇