agentleFS
EndogenAIEndogenAI/dogma/.github/skills/skill-authoring/SKILL.md

skill-authoring

Skill2 starsChanged 8 months agoApache-2.0View on GitHub

Encodes conventions for authoring SKILL.md files in .github/skills/<name>/: YAML frontmatter, required headings, issue linkage, governance metadata, and CI validation. USE FOR: creating or modifying reusable domain-specific skills; understanding skill vs agent distinction; packaging procedural knowledge for cross-agent use. DO NOT USE FOR: agent file authoring (use agent-file-authoring skill); creating new agents (use that skill first); general VS Code settings questions.

89 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use cloud-api-recipe-authoring, codebuddy-ide-mcp-upgrade and 10 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.
  • TencentCloudBaseSkill

    cloud-api-recipe-authoring

    Author or revise a cloud-api-operations recipe (config/source/skills/cloud-api-operations/references/recipes/). Encodes why the long tail of control-plane capabilities is deliberately NOT wrapped as MCP/CLI tools, the API-first admission test for whether a capability deserves a recipe, the negative and positive lists, the fixed recipe structure, the writing rules distilled from writing-for-agents, the user-facing copy red lines, and the product regeneration/verification pipeline. Also routes contributors (and their agents) to the contribution flow and the pre-PR self-test protocol in references/contributing.md. Use when adding a recipe, judging whether a scenario belongs in the recipe set, updating the recipes index, re-checking existing recipes against the admission test, or onboarding someone who wants to submit one.

    Also in 3 projects that use this

  • TencentCloudBaseSkill

    codebuddy-ide-mcp-upgrade

    升级 CodeBuddy IDE(genie 扩展)内置的 CloudBase MCP,以及 MCP 发版时同步 IDE 侧白名单。当用户提到「更新 IDE 里的 MCP」「内置 MCP 版本太老」「IDE 集成的 CloudBase 功能不足」「改工具白名单 toolWhiteList」「把新 bundle 打进 CodeBuddy」「白名单漂移」「MCP 发版要同步什么」时使用。覆盖:解包定位内置 bundle 与内嵌配置、重新构建 mcp bundle、生成新的工具白名单与系统提示词、安全注入 IDE 并备份、用 MCP 协议验证工具清单、人工端到端验收、一键回滚。

    Also in 3 projects that use this

  • DIL8654Skill

    api-contract-review

    Review ASP.NET Core Web API contracts for HTTP semantics, versioning, backward compatibility, and response consistency. Use when the user asks to review an API, check endpoints, validate REST behavior, or before releasing contract changes.

    Also in 5 projects that use this

  • zaxbysauceSkill

    pr-review-fix

    Codex adapter for addressing pull request review feedback in opencode-swarm. Use when the user asks to fix PR review comments, requested changes, reviewer findings, CI-review notes, or a pasted review summary with low false-positive tolerance.

    Also in 3 projects that use this

  • albertdobmeyerSkill

    git-workflows

    Advanced git operations beyond add/commit/push. Use when rebasing, bisecting bugs, using worktrees for parallel development, recovering with reflog, managing subtrees/submodules, resolving merge conflicts, cherry-picking across branches, or working with monorepos.

    Also in 3 projects that use this

  • rogue-dev-studioSkill

    frontend-engineering

    Expert frontend application engineering: accessible UI structure, state and data-fetching discipline, form/validation UX, responsive layouts, performance budgets, and integration with API contracts. Use when building or refining SPA/web screens, design-system consumption, client-side routing, or fixing UI reliability (loading, empty, and error states).

    Also in 3 projects that use this

  • +6 more from TencentCloudBase

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 80 edited versions we read keep these.

  • 9

    Distinctive

    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:

    Every skill file must open with YAML frontmatter:

    line 35
  2. Distinctive:

    Every skill file must contain at least one of each:

    line 81
  3. Distinctive:

    Discipline rule for Endogenous Sources section: Always encode:

    line 89
  4. Distinctive:

    Extraction test: If a procedure in an agent body would benefit a *different* agent or tool without requiring that agent's posture or …

    line 131
  5. Distinctive:

    Every skill file must contain at least one back-reference to the foundational document that governs it:

    line 170
  6. Distinctive:

    Use this template structure for new skills:

    line 215
  7. Distinctive:

    Before committing a new or modified skill:

    line 274
  8. Distinctive:

    Do not add a skill without running the CI linter and passing all checks

    line 302
  9. Distinctive:

    Do not introduce a procedure that is not grounded in an existing AGENTS.md principle or a prior-art pattern

    line 303

“Common” is measured: kept by at least 6 in 10 of the 80 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

SKILL.md Authoring

This skill enacts the Endogenous-First axiom from MANIFESTO.md: skills are re-encodings of documented procedures and patterns from AGENTS.md, not independent inventions.

Skills are tactical-layer knowledge artifacts that encode how a task is done. They sit beneath agents (who encode who does a task) and above session behavior.


1. File Naming and Location

  • Location: .github/skills/<skill-name>/SKILL.md
  • Slug format: kebab-case, lowercase, e.g. deep-research-sprint, pr-review-reply, session-management
  • One skill per domain — do not combine multiple domain procedures into a single skill file

To create a new skill, create the directory .github/skills/<skill-name>/ and add a SKILL.md file. You can copy an existing SKILL.md as a starting point — for example:

cp .github/skills/source-caching/SKILL.md .github/skills/<skill-name>/SKILL.md

Then update the frontmatter and sections according to the conventions in this document.


2. YAML Frontmatter

Every skill file must open with YAML frontmatter:

---
name: <skill name in kebab-case>
description: |
  <Clear description of what this skill encodes — ≥25 characters>
  USE FOR: [bullet list of appropriate use cases]
  DO NOT USE FOR: [bullet list of what this skill explicitly excludes]
argument-hint: "usage hint shown in chat input box"
---

Field requirements:

FieldRequiredConstraint
nameYesKebab-case, lowercase
descriptionYes≥ 25 characters, includes USE FOR / DO NOT USE FOR
argument-hintOptionalBrief input suggestion for the user

Discipline fields (encode project governance):

---
name: deep-research-sprint
description: "Orchestrates ..."

# Optional — encode milestone/effort/applicability
tier: Foundation                          # Which milestone this skill applies to
type: research                            # Type: research | feature | scripting | automation | tooling | validation
effort: L                                 # Effort for practitioner to execute: s/m/l/xl
applies-to:                               # Which agent roles use this skill
  - Executive Researcher
  - Research Scout
status: active                            # Status: active | beta | deprecated | blocked
requires:                                 # Dependencies on other skills or tools
  - name: source-caching
    description: "Must cache sources before scouting"
---

3. Required Sections

Every skill file must contain at least one of each:

CategoryAccepted heading variantsPurpose
Endogenous SourcesEndogenous Sources, Sources, Reference, ContextDeclare governing axioms, link to issues/patterns, citation chain
Core Procedure/WorkflowWorkflow, Steps, Procedure, How ToDefine the task sequence
Quality-gate/CompletionCompletion Criteria, Done When, Acceptance Criteria, ValidationState what "executed correctly" looks like

Discipline rule for Endogenous Sources section: Always encode:

  1. The governing axiom this skill enacts (from MANIFESTO.md)
  2. The pattern or GitHub issue this skill implements (e.g., #45 Research: Product Definition)
  3. Which agents and tools depend on this skill
  4. Citation chain to foundational documents

Example Beliefs & Context:

## Beliefs & Context

This skill enacts the *Endogenous-First* axiom from [`MANIFESTO.md`](../../../MANIFESTO.md) by encoding the complete research sprint workflow as a reusable procedure.

**Implements**: The research orchestration pattern from issue [#45 (Research: Product Definition)](https://github.com/EndogenAI/dogma/issues/45)

**Used by**:
- Executive Researcher (orchestrates fleet)
- Research Scout (gathers sources)
- Research Synthesizer (transforms findings)
- Research Reviewer (validates output)
- Research Archivist (commits deliverables)

**Foundation documents**:
- [`AGENTS.md`](../../../AGENTS.md) — governance constraints
- [`docs/guides/deep-research.md`](../../../docs/guides/deep-research.md) — full investigation methodology
- [`docs/research/methodology-review.md`](../../../docs/research/methodology/methodology-review.md) — prior art survey

4. Skill vs Agent — Composition Rule

When to create a skill (not an agent):

SignalDecision
Procedure needed by 1 agent only; unique postureCreate as agent body — embed procedure
Procedure needed by 2+ different agents/tools; no posture dependencyExtract to skill — reference from agents
Tactical workflow; could benefit multiple roles; tool-agnosticSkill is appropriate
Authorization/oversight required; must gate executionAgent with Review handoff is appropriate

Extraction test: If a procedure in an agent body would benefit a different agent or tool without requiring that agent's posture or handoff logic, move it to a skill and reference it from both agents.


5. Link Path Rule

All links in skill files that exit .github/skills/<name>/ must use ../../../ relative paths. This is consistent with the agent file convention (../../ for depth-2 files) and ensures VS Code's prompts-diagnostics-provider can resolve them.

/-rooted paths (e.g. /AGENTS.md) resolve to the OS filesystem root on macOS, not the workspace root — they produce VS Code Problems panel errors.

.github/skills/my-skill/SKILL.md
  │
  ├─ ../              → .github/skills/   ← WRONG (wrong target)
  ├─ ../../           → .github/          ← WRONG (wrong target)
  ├─ /AGENTS.md       → OS filesystem root ← WRONG (resolves to /AGENTS.md on macOS)
  └─ ../../../        → (repo root)       ← CORRECT (depth 3 from repo root)

Correct usage for skills:

[`MANIFESTO.md`](../../../MANIFESTO.md)
[`AGENTS.md`](../../../AGENTS.md)
[`docs/guides/agents.md`](../../../docs/guides/agents.md)
[`.github/agents/README.md`](../../agents/README.md)

Within-directory links (to sibling files in .github/skills/<name>/) remain relative:

[`./other-file.md`](./other-file.md)   ← same directory: OK

This convention is enforced by the no-absolute-path-links-in-agent-files pre-commit hook.


6. Cross-Reference Density

Every skill file must contain at least one back-reference to the foundational document that governs it:

  • Pure procedural skills → reference AGENTS.md
  • Research-oriented skills → reference MANIFESTO.md (Endogenous-First axiom)
  • Automation/scripting skills → reference AGENTS.md § Programmatic-First

Minimum pattern (place in Endogenous Sources):

This skill enacts the *<Axiom Name>* axiom from [`MANIFESTO.md`](../../../MANIFESTO.md).
It is governed by [`AGENTS.md`](../../../AGENTS.md) and associated procedural guidelines.

7. Encoding Inheritance Declaration

The skill's first substantive section must ground it in the encoding chain:

## Beliefs & Context

This skill enacts the *<Axiom>* axiom from [`MANIFESTO.md`](../../../MANIFESTO.md).

**Implements**: [Pattern or issue reference]

**Governed by**: [`AGENTS.md`](../../../AGENTS.md) § [relevant section]

Read [`docs/guides/agents.md`](../../../docs/guides/agents.md) before modifying this skill.

Governing axioms by skill type:

Skill typeGoverning axiom(s)
Research proceduresEndogenous-First
Scripting / automationAlgorithms Before Tokens
Documentation / synthesisEndogenous-First
Validation / testingAlgorithms Before Tokens
Multi-phase orchestrationEndogenous-First + Algorithms Before Tokens

8. Completeness Template

Use this template structure for new skills:

---
name: <skill-name>
description: |
  <Clear description>
  
  USE FOR: [bullet list]
  DO NOT USE FOR: [bullet list]
argument-hint: "<usage hint>"

# Governance metadata
tier: <Foundation|Wave 1|Wave 2|...>
type: <research|feature|scripting|automation|tooling|validation>
effort: <s|m|l|xl>
applies-to:
  - <Agent Name>
status: active
---

# <Skill Title>

## Beliefs & Context

[Declare axioms, pattern, dependent agents, foundational docs]

---

## <Core Workflow/Procedure>

[Step-by-step instructions, code examples, decision trees]

---

## <Quality Gate/Completion Criteria>

[What constitutes successful execution]

---

## Guardrails

- [Never do X]
- [Always do Y]

9. No Heredocs in Skill Bodies

Like agents, skill files must not contain cat >> file << 'EOF' patterns or inline Python heredoc writes in example steps.

Instead: Instruct practitioners to use create_file (new files) or replace_string_in_file (edits) — both are safe for Markdown content.


10. Validate Before Committing

Before committing a new or modified skill:

uv run python scripts/validate_agent_files.py --skills
# To validate a single skill:
uv run python scripts/validate_agent_files.py .github/skills/<skill-name>/SKILL.md

Pre-commit checklist:

  • ✅ Frontmatter has all required fields (name, description with USE FOR / DO NOT USE FOR)
  • ✅ Optional governance fields present (tier, type, effort, applies-to, status)
  • ✅ All repo-root paths use ../../../ prefix (not ../../)
  • ✅ Endogenous Sources declares governing axiom
  • ✅ Endogenous Sources references defining issue or pattern
  • ✅ Completion Criteria section defines success
  • ✅ No heredoc patterns in workflow steps
  • ✅ All cross-references to foundational docs are correct links
  • ✅ No orphaned or broken internal links

Guardrails

  • Never use ../../ for repo-root references in skills — always ../../../ (one extra level up from agents)
  • Never omit the Endogenous Sources section — encoding fidelity depends on it
  • Never combine multiple domains in one skill — one skill per bounded domain
  • Never create a skill without understanding the agent(s) that will use it — ask yourself: which agents will benefit from this?
  • Do not add a skill without running the CI linter and passing all checks
  • Do not introduce a procedure that is not grounded in an existing AGENTS.md principle or a prior-art pattern

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.