microsoft / microsoft/agentrc

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

Open
#99 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.1k
Forks
94
Avg merge
8d 3h
Merged PRs (30d)
7

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running agentrc instructions --areas on agentrc or another TypeScript repository, then review the related APM issues and the apm init --plugin workflow. Create the reference package with apm.yml, plugin.json, .apm/instructions/, and README.md, and write the lifecycle guide with real commands and output. Done means a fresh project can install the package locally and the guide covers generation through CI governance.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, markdown, typescript
Domain
devops, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.