Skip to content

docs: reference APM package + agentrc-to-APM lifecycle guide #99

@danielmeppiel

Description

@danielmeppiel

Why

agentrc generates high-quality, repo-aware .instructions.md files. APM distributes them across teams. The formats are compatible (analysis). But there is no worked example showing the full lifecycle: generate with agentrc → curate → package for APM → publish → install → govern in CI.

Without this reference, developers must figure out the workflow themselves. The ecosystem has zero agentrc-enhanced APM packages. We need the first one to prove the narrative and create a template others follow.

What

1. Reference APM package

A new repo (e.g., microsoft/apm-sample-instructions) containing curated, reusable instructions originally generated by agentrc:

apm-sample-instructions/
├── apm.yml                                    # APM manifest
├── plugin.json                                # Plugin metadata
├── .apm/
│   └── instructions/
│       ├── typescript-conventions.instructions.md
│       ├── testing-standards.instructions.md
│       └── code-review.instructions.md
└── README.md                                  # Documents what's included + how to install

Each .instructions.md has proper description + applyTo frontmatter. Content is authored by running agentrc instructions on a real TypeScript repo, then generalizing the output for reuse across projects.

Installable: apm install microsoft/apm-sample-instructions

2. Lifecycle guide

Documentation (in agentrc docs or APM docs or both) walking through:

  1. Generateagentrc init or agentrc instructions --areas on a repo
  2. Curate — Pick the reusable patterns, generalize repo-specific details
  3. Package — Create a new repo with apm init --plugin, place instructions in .apm/instructions/
  4. Publish — Push to GitHub (or any git host APM supports)
  5. Consumeapm install org/my-package in any project
  6. Governmicrosoft/apm-action in CI, apm-policy.yml with dependencies.require

The guide should be practical — showing actual commands, actual file contents, actual output. Not conceptual.

How

Reference package

  • Run agentrc instructions --areas on agentrc itself (or another real TypeScript repo)
  • Extract 2-3 instruction files that are genuinely reusable (e.g., TypeScript conventions, testing patterns)
  • Generalize: replace repo-specific paths/names with generic patterns
  • Create new repo with apm init --plugin, move instructions to .apm/instructions/
  • Verify: apm install ./path-to-package works in a fresh project

Guide

  • Markdown document (~200 lines)
  • Include real terminal output at each step
  • Link to the reference package as the worked example

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions