Skip to content

Commit 08b191a

Browse files
tablackburnclaude
andauthored
feat: deploy AIM (AI Agent Instruction Modules) (#122)
Phase 0 of #120 — deploy [AIM (AI Agent Instruction Modules)](https://github.com/tablackburn/ai-agent-instruction-modules) as the first PR of the v1.0.0 cycle. ## What's included - `AGENTS.md` (root) — agent-facing entry point with instruction matrix; Last sync: 2026-05-17 (AIM 0.8.14) - `aim.config.json` — module configuration; external sources enabled (awesome-copilot fallback) - `instructions/` — 12 instruction modules: - Core: `agent-workflow`, `shorthand`, `git-workflow`, `testing`, `update` - Language/tools: `powershell`, `markdown`, `readme`, `github-cli` - Repository management: `releases`, `contributing` - Repo-specific: `repository-specific.instructions.md` (migrated from CLAUDE.md) - `CLAUDE.md` — one-line `@AGENTS.md` import so Claude Code auto-loads AIM context (see "CLAUDE.md handling" below) ## CLAUDE.md migration CLAUDE.md content was migrated to `instructions/repository-specific.instructions.md`, keeping only repo-specific content (project layout, `$PSBPreference` internals, task dependency variables, naming conventions, build workflows, BuildHelpers env vars). Generic content covered by standard AIM modules (PowerShell style, git workflow, generic testing patterns) was dropped to avoid duplication. Stale references corrected during migration: - Version: 0.7.3 → 0.8.0 - Public function count: 9 → 12 (signing functions added in 0.8.0) ## CLAUDE.md handling The original CLAUDE.md was deleted, then re-added as a one-line file containing only `@AGENTS.md`. Reason: Claude Code auto-loads `CLAUDE.md` from the project root but does not auto-load `AGENTS.md` ([memory docs](https://code.claude.com/docs/en/memory.md)). Using the official `@`-import syntax means fresh Claude Code sessions in this repo automatically pick up AIM context (AGENTS.md → instruction matrix → applicable modules) without needing a manual pointer in every prompt. This matches the AIM source repo, which ships both `AGENTS.md` and `CLAUDE.md`. ## AIM 0.8.14 sync Bumped from 0.8.13 → 0.8.14 (released 2026-05-16). Pulls three instruction-file fixes from [tablackburn/ai-agent-instruction-modules#24](tablackburn/ai-agent-instruction-modules#24): - **`contributing.instructions.md`** — "Make Changes" pointed contributors at `instructions/` instead of `instruction-templates/`. Surfaced during Copilot review of this PR and filed upstream as [tablackburn/ai-agent-instruction-modules#23](tablackburn/ai-agent-instruction-modules#23). - **`github-cli.instructions.md`** — "Creating Releases" example used `gh release create --notes`, contradicting `releases.instructions.md` which mandates `--notes-file` to avoid escaping issues. Replaced with a temp-file pattern and added a precedence note. Also surfaced during this PR's review; same upstream issue. - **`shorthand.instructions.md`** — backfilled the missing `Dir → Directory` row (pre-existing sync drift in the upstream template; fixed in the same upstream PR). `AGENTS.md` Template Version 0.8.13 → 0.8.14 and Last sync 2026-05-15 → 2026-05-17. ## Scope Docs/config-only — no module code changes. Verified locally: - `git diff --stat origin/main`: 16 files changed, 0 under `PowerShellBuild/`, `requirements.psd1`, `CHANGELOG.md`, or `.github/` - `./build.ps1 -Task Test -Bootstrap` passes (314 passed, 0 failed, 2 skipped — the skips are git-tagging tests that expectedly skip on feature branches) - Module version, dependencies, and CI workflows untouched ## Note on module count vs #120 checklist #120's Phase 0 checklist lists 8 modules. This PR deploys 12 — the additional `readme`, `contributing`, `update`, and `repository-specific` modules were included per the Phase 0 deployment scope I worked from. Happy to drop any of them if the tracking issue's narrower list was intentional. ## Phase 0 checklist (#120) - [x] Add `AGENTS.md`, `aim.config.json`, `instructions/` - [x] Migrate `CLAUDE.md` content → `instructions/repository-specific.instructions.md` - [x] Modules included: `agent-workflow`, `shorthand`, `git-workflow`, `testing`, `powershell`, `markdown`, `releases`, `github-cli` (plus `readme`, `contributing`, `update`, `repository-specific` — see note above) - [x] Fix stale version reference (CLAUDE.md said 0.7.3; actual is 0.8.0) ## Commits 1. `feat: deploy AIM (AI Agent Instruction Modules)` — main deployment + CLAUDE.md content migration + CLAUDE.md deletion 2. `docs: add CLAUDE.md as @AGENTS.md import for Claude Code auto-loading` — restore CLAUDE.md as a 1-line pointer 3. `docs: address Copilot review feedback on repository-specific instructions` — Sign/Catalog rows, IB alias examples, `-FromModule` psake pattern, signing task dependency + task rows 4. `docs: sync AIM 0.8.14 fixes (contributing folder, gh release notes, Dir row)` — pull the three instruction-file fixes from AIM 0.8.14 and bump template version + sync date 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 1b16805 commit 08b191a

15 files changed

Lines changed: 2629 additions & 410 deletions

AGENTS.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# AI Agent Instructions
2+
3+
AI agents working in this repository must follow these instructions.
4+
5+
Template Version: 0.8.14
6+
7+
Last sync: 2026-05-17 (Update this date when syncing from the centralized repository)
8+
9+
## Instructions for AI Agents
10+
11+
AI agents **must**:
12+
13+
1. **When deploying or updating this template, follow `instructions/update.instructions.md` and
14+
update the Last sync date above.**
15+
16+
2. **Read `instructions/agent-workflow.instructions.md` FIRST to determine which other instruction
17+
files apply to your task.** Follow all applicable instructions before proceeding with work.
18+
19+
3. **Check `aim.config.json`** for module configuration and external source settings.
20+
21+
## Instruction Applicability Matrix
22+
23+
Use this matrix to determine which instruction files to read based on your task:
24+
25+
| Task Type | Required Instructions |
26+
| ---------------------------- | -------------------------------------- |
27+
| Any task | `agent-workflow.instructions.md` |
28+
| Any code or documentation | `shorthand.instructions.md` |
29+
| Git operations | `git-workflow.instructions.md` |
30+
| Writing tests | `testing.instructions.md` |
31+
| PowerShell code | `powershell.instructions.md` |
32+
| Documentation | `markdown.instructions.md` |
33+
| README files | `readme.instructions.md` |
34+
| GitHub CLI usage | `github-cli.instructions.md` |
35+
| Creating releases | `releases.instructions.md` |
36+
| Repository-specific work | `repository-specific.instructions.md` |
37+
| Updating instructions | `update.instructions.md` |
38+
| Contributing to upstream | `contributing.instructions.md` |
39+
40+
## Available Instruction Files
41+
42+
- `agent-workflow.instructions.md` - Pre-flight protocol and task workflow
43+
- `shorthand.instructions.md` - Avoid shorthand and abbreviations
44+
- `git-workflow.instructions.md` - Git branching, commits, and PR conventions
45+
- `testing.instructions.md` - Test writing best practices
46+
- `powershell.instructions.md` - PowerShell coding standards
47+
- `markdown.instructions.md` - Markdown formatting standards
48+
- `readme.instructions.md` - README maintenance guidelines
49+
- `github-cli.instructions.md` - GitHub CLI usage guidelines
50+
- `releases.instructions.md` - Release management guidelines
51+
- `repository-specific.instructions.md` - Repository-specific customizations
52+
- `update.instructions.md` - Procedures for updating instructions
53+
- `contributing.instructions.md` - Contributing improvements to upstream
54+
55+
## Quick Reference
56+
57+
### Before Starting Any Task
58+
59+
1. Identify the task type from the matrix above
60+
2. Read all applicable instruction files
61+
3. Follow the guidelines when implementing
62+
63+
### Best Practices
64+
65+
- Follow existing patterns in the codebase
66+
- Keep solutions simple and focused
67+
- Only make changes that are directly requested
68+
- Follow language-specific guidelines
69+
70+
## Repository-Specific Instructions
71+
72+
See `instructions/repository-specific.instructions.md` for customizations specific to this repository.

0 commit comments

Comments
 (0)