agentleFS
Microsoft AzureKnown publisherAzure/azure-verified-modules-tools/.github/copilot-instructions.md

azure-verified-modules-tools

Copilot instructions3 starsChanged 9 days agoMITView on GitHub

This is the repository's only agent instruction file. Read docs/quality-spec.md before changing code. It is the general quality standard for durable engineering principles, not an implementation manual or a catalog of current technical contracts. Keep it focused on correctness, security, reliability, maintainability, performance, testing, and documentation standards. Do not add file layouts, workflow matrices, exact implementation behavior, incident histories, or step-by-step operational instructions. Keep executable contracts in source, tests, build configuration, and workflows; keep contributor procedures in contributor documentation. Update…

  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,336 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

The file

Show its rules and text

We split this copilot-instructions.md into the rules it gives an agent

14 rules. About 1 is common, 10 are distinctive, and 3 are very specific to this project.

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈10

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Do not create progress, planning, handoff, or decision-history documents.

    line 17
  2. Distinctive:

    Keep changes focused and preserve existing behavior unless the requested change deliberately alters it.

    line 19
  3. Distinctive:

    Use PowerShell 7.4+ and the existing helpers and patterns.

    line 21
  4. Distinctive:

    Every exported function must have complete comment-based help covering its purpose, behavior, parameters, examples, and outputs.

    line 23
  5. Distinctive:

    Keep inline comments rare.

    line 25
  6. Distinctive:

    Use only the repository build entry point:

    line 30
  7. Distinctive:

    Never hand-edit generated reference pages.

    line 50
  8. Very specific:

    Run ./build.ps1 pre-commit before committing code changes.

    line 52
  9. Distinctive:

    Use LF and UTF-8 without BOM.

    line 58
  10. Very specific:

    Use approved verbs and the Avm noun prefix for exported functions.

    line 59
  11. Common:

    Use typed exceptions and explicit errors.

    line 60
  12. Very specific:

    Use [CmdletBinding(SupportsShouldProcess)] for state-changing cmdlets.

    line 65
  13. Distinctive:

    Add tests at the smallest appropriate layer and keep check modes non-writing.

    line 67
  14. Distinctive:

    Use a Conventional Commit with a first line no longer than 72 characters.

    line 74

≈ “Common” is an estimate: at least 1 in 5 of the 3,779 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

Copilot instructions

This is the repository's only agent instruction file. Read docs/quality-spec.md before changing code. It is the general quality standard for durable engineering principles, not an implementation manual or a catalog of current technical contracts. Keep it focused on correctness, security, reliability, maintainability, performance, testing, and documentation standards. Do not add file layouts, workflow matrices, exact implementation behavior, incident histories, or step-by-step operational instructions. Keep executable contracts in source, tests, build configuration, and workflows; keep contributor procedures in contributor documentation. Update this spec only when a durable quality standard changes.

Working rules

  • Work on the current feature branch. Never push to main or force-push.
  • Do not create progress, planning, handoff, or decision-history documents. Git history, issues, and pull requests record completed work.
  • Keep changes focused and preserve existing behavior unless the requested change deliberately alters it.
  • Use PowerShell 7.4+ and the existing helpers and patterns. Do not introduce Bash scripts.
  • Every exported function must have complete comment-based help covering its purpose, behavior, parameters, examples, and outputs.
  • Keep inline comments rare. Use one only when the code cannot make a necessary local constraint clear.

Build and generated documentation

Use only the repository build entry point:

./build.ps1 layout
./build.ps1 lint
./build.ps1 test
./build.ps1 component
./build.ps1 docs
./build.ps1 docs-check
./build.ps1 pre-commit

./build.ps1 docs regenerates docs/reference/ from the comment-based help on every exported cmdlet. Run it whenever an exported function, parameter, or help block changes, then commit the generated Markdown.

./build.ps1 docs-check is non-writing and fails when generated pages are missing, stale, or unexpected. It runs as part of pre-commit, ci, ci-tests, ci-unit, and ci-coverage, so pull-request checks fail until the reference is regenerated. Never hand-edit generated reference pages.

Run ./build.ps1 pre-commit before committing code changes. Documentation-only changes that do not affect generated cmdlet reference may skip the full gate.

Mandatory implementation practices

  • PowerShell Core only; support Windows, Linux, and macOS.
  • Use LF and UTF-8 without BOM.
  • Use approved verbs and the Avm noun prefix for exported functions.
  • Use typed exceptions and explicit errors; do not hide failures or return success-shaped fallbacks.
  • Invoke subprocesses only through Invoke-AvmProcess with argument arrays.
  • Route HTTP through the shared networking helpers and preserve checksum, certificate, offline, retry, and source-host controls.
  • Use [CmdletBinding(SupportsShouldProcess)] for state-changing cmdlets.
  • Preserve module and manifest casing exactly.
  • Add tests at the smallest appropriate layer and keep check modes non-writing.
  • GitHub Actions workflow names use <Group>: <Name>; job and step display names use sentence case without an [AVM] prefix.

Commit and pull-request protocol

  • Stage the complete focused change, including generated docs.
  • Use a Conventional Commit with a first line no longer than 72 characters.
  • Include the required Copilot commit trailers supplied by the session.
  • Push the current feature branch after the local gate passes.
  • Reuse an existing open pull request for the branch. If none exists, open one against main. Do not merge or close it without explicit user instruction.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.