agentleFS
YassimbaYassimba/loom/skills/blueprint/SKILL.md

blueprint

Skill9 starsChanged 2 months agoApache-2.0View on GitHub

Sketch a proposed code change visually with Mermaid before implementation.

66 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use assess, align and 9 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • AWSSkill

    assess

    Run a 5-domain CAF security posture assessment for an AWS service. Produces (1) assessment-summary.md — CAF-structured findings with GAPS tables, (2) sar-facts.json — extracted SAR data, (3) checkpoint-results.json — factual checkpoint verification. These feed into the research, validate, and generate phases.

    Also in 3 projects that use this

  • marylinSkill

    align

    Audit project structure, docs health, and lifecycle compliance. Use when a project feels disorganized, after major refactors, before onboarding a contributor, or periodically as a health check.

    Also in 3 projects that use this

  • sahinSkill

    execute

    Also in 5 projects that use this

  • LangChainSkill

    docker-patterns

    Best practices for Docker containerization and multi-stage builds

    Also in 3 projects that use this

  • lukeleekrSkill

    scout

    GitHub 레포 스카우터. 내 Claude Code + Codex App 환경을 분석하여 필요한 GitHub 레포를 자동 추천하거나, 키워드로 GitHub을 검색합니다. "scout", "스카우트", "깃헙 탐방", "레포 추천", "repo search" 등의 키워드에 반응합니다.

    Also in 3 projects that use this

  • genomewalkerSkill

    learn

    Learn from web sources, generate SKILL.md, and store key patterns in soul memory. Trigger keywords: learn, skill-gen, web-learn, documentation, tutorial.

    Also in 7 projects that use this

The file

We split this skill into the rules it gives an agent

3 rules. 0 are common, 2 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 65 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use fenced mermaid blocks.

    line 19
  2. Distinctive:

    Add object lineage or lifecycle views when they make the proposal easier to assess.

    line 22
  3. Distinctive:

    Use the diagram types that fit.

    line 23

“Common” is measured: kept by at least 6 in 10 of the 65 edited versions of this file we could read. “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

Blueprint

Design the proposed change, load the ponytail skill if available and reuse as much of the existing code and interfaces before adding abstractions or dependencies.

Run the code-contracts skill's obligation sweep while designing. Once the direction is approved, write each approved contract into its existing target declaration or CONTRACTS file before implementation begins; make contract-only edits and validate them with cc-check format and cc-check list. Do not create implementation scaffolding merely to host a contract. When the target code does not exist yet or an assumption still needs approval, leave the contract in the blueprint instead.

Include a ## Code contracts section listing materialized contracts by path and ID, followed by unmaterialized proposals with their intended path, exact @cc text, and blocker. If no candidate survives the skill's violation-and-alternative test, say so and explain why. Completion: no approved contract remains only in the blueprint when a valid code location already exists.

Then present the change using mermaid diagrams, clear enough to decide whether and how to build it: the goal, current versus proposed behavior, affected code, key trade-offs, and how success will be verified. Ground existing behavior in source; distinguish proposals and unknowns from facts.

Use fenced mermaid blocks; they render automatically in the user's session. At minimum, show the structure, input and output flow, interface dependencies, code-contract status, and a code snippet of the main interfaces.

Add object lineage or lifecycle views when they make the proposal easier to assess. Use the diagram types that fit. Use complementary views for distinct questions.

Mark upcoming changes with :::red for removed, :::green for added, and :::orange for changed.

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.