docs: reference APM package + agentrc-to-APM lifecycle guide
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 42/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- github-actions, markdown, typescript
- Domain
- devops, documentation
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.
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:
- Generate —
agentrc initoragentrc instructions --areason a repo - Curate — Pick the reusable patterns, generalize repo-specific details
- Package — Create a new repo with
apm init --plugin, place instructions in.apm/instructions/ - Publish — Push to GitHub (or any git host APM supports)
- Consume —
apm install org/my-packagein any project - Govern —
microsoft/apm-actionin CI,apm-policy.ymlwithdependencies.require
The guide should be practical — showing actual commands, actual file contents, actual output. Not conceptual.
How
Reference package
- Run
agentrc instructions --areason 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-packageworks 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
- Epic: #96
- APM init bridge: microsoft/apm#518
- APM policy custom checks: microsoft/apm#519
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 94
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 36
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/agentrc
-
agentic-workflows automation
Difficulty 3/5 Half a day Newbie friendliness 30/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 25/100
microsoft/agentrc#379 · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
microsoft/agentrc#372 · 2 reactions ·
Maintainers usually reply within 1 day
-
[aw] Detection RunsOpenagentic-workflows
Difficulty 5/5 Over a week Newbie friendliness 1/100
microsoft/agentrc#349 · 8 comments ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Maintainers usually reply within 1 day
All issues in microsoft/agentrc
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
yjh051108/dsh-routing-suite#216 ·
-
kind/bug priority/needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Dependencies view: `getParent` loops forever on untitled documents, extension host runs out of memoryPossibly taken A pull request linked to this issue is open or already merged. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
enhancement good first issue
Difficulty 2/5 Half a day Newbie friendliness 66/100
apache/fineract-consumer-facing#175 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 Under an hour Newbie friendliness 82/100
awslabs/visual-asset-management-system#413 ·
Maintainers usually reply within 1 day