Skip to content

Rewrite AGENTS.md for integration subpackage architecture#2068

Draft
Copilot wants to merge 3 commits intomainfrom
copilot/rewrite-agents-md-for-integration-architecture
Draft

Rewrite AGENTS.md for integration subpackage architecture#2068
Copilot wants to merge 3 commits intomainfrom
copilot/rewrite-agents-md-for-integration-architecture

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 2, 2026

AGENTS.md documented the old AGENT_CONFIG dict-based process (edit dict, update help text, modify release scripts, add case statements). Since #1924 shipped the integration subpackage architecture, AI agents following this guide produce incorrect changes.

Removed

  • Supported Agents table — redundant with integration class definitions; drifts
  • 7-step guide — references AGENT_CONFIG, release ZIP scripts, --ai-skills flag, case statements — all gone
  • Agent Categories / Directory Conventions — derivable from requires_cli and registrar_config.dir on each class

Added

  • Architecture overviewintegrations/<key>/ subpackage structure, INTEGRATION_REGISTRY as single source of truth
  • Base class decision treeMarkdownIntegration / TomlIntegration / SkillsIntegration / IntegrationBase
  • Step-by-step guide — create subpackage → register → add scripts → test → optional overrides
  • Real code examples pulled from existing integrations (Windsurf, Gemini, Codex, Copilot)

Kept unchanged

  • About Spec Kit and Specify, Command File Formats, Argument Patterns, Devcontainer section

A minimal new integration now looks like:

class WindsurfIntegration(MarkdownIntegration):
    key = "windsurf"
    config = {"name": "Windsurf", "folder": ".windsurf/", "commands_subdir": "workflows",
              "install_url": None, "requires_cli": False}
    registrar_config = {"dir": ".windsurf/workflows", "format": "markdown",
                        "args": "$ARGUMENTS", "extension": ".md"}
    context_file = ".windsurf/rules/specify-rules.md"

Plus one import + _register() call in _register_builtins() and two thin wrapper scripts.

Copilot AI and others added 2 commits April 2, 2026 18:39
Replaces the old AGENT_CONFIG dict-based 7-step process with documentation
reflecting the integration subpackage architecture shipped in #1924.

Removed: Supported Agents table, old step-by-step guide referencing
AGENT_CONFIG/release scripts/case statements, Agent Categories lists,
Directory Conventions section, Important Design Decisions section.

Kept: About Spec Kit and Specify, Command File Formats, Argument Patterns,
Devcontainer section.

Added: Architecture overview, decision tree for base class selection,
configure/register/scripts/test/override steps with real code examples
from existing integrations (Windsurf, Gemini, Codex, Copilot).

Agent-Logs-Url: https://github.com/github/spec-kit/sessions/71b25c53-7d0c-492a-9503-f40a437d5ece

Co-authored-by: mnriem <15701806+mnriem@users.noreply.github.com>
Copilot AI changed the title [WIP] Update AGENTS.md for integration subpackage architecture Rewrite AGENTS.md for integration subpackage architecture Apr 2, 2026
Copilot AI requested a review from mnriem April 2, 2026 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rewrite AGENTS.md for integration subpackage architecture

2 participants