Skip to content

docs: add copilot agent instructions with the fleet working agreements - #39

Merged
tyrsson merged 1 commit into
1.0.xfrom
docs/agent-working-agreements
Sep 26, 2026
Merged

tyrsson merged 1 commit into
1.0.xfrom
docs/agent-working-agreements

Conversation

@tyrsson

@tyrsson tyrsson commented Sep 26, 2026

Copy link
Copy Markdown
Member

Types of changes

  • Bug fix
  • New feature
  • Breaking change

None apply: this adds a Markdown instruction file. No code path, no package behaviour.

Checklist:

  • An issue has been created for this pull request. — none exists; this is fleet instruction adoption.
  • I have added tests for my changes. — not applicable; the file is documentation.
  • All new and existing tests passed.
  • Documentation has been updated accordingly.
  • This pull request targets the correct branch.

Description

Adds .github/copilot-instructions.md. This package had none, so nothing in the repository carried
the fleet working agreements.

The file is generated from the preset source of truth,
webware-tools:presets/webware-alignment/artifacts/copilot-instructions.md, with the package title
substituted, so it matches what every other package carries rather than being written from scratch.

It contains the fleet working-agreements block first, then the standard sections: Mago docblock-only
types and class-reference string types, the PHPUnit mock-versus-stub rules, and the coverage metadata
rules.

Motivation and Context

The rules that govern how work is done in this fleet — scope discipline, reporting, git and release
handling — now live in version control rather than in machine-local agent memory:
webware-tools/agent-working-agreements.md is the source, and the preset artifact mandates it.

That only takes effect in a repository that has a copilot-instructions.md, because that file is
loaded automatically in every session and reviewed like any other file. Fourteen packages already
carry it; this one was missing it entirely, so its sessions ran with no fleet rules at all.

The four non-negotiables are carried inline rather than only referenced, so the block works
before a webware-tools release makes the vendored path resolve in this package.

How has this been tested?

  • The diff is one new Markdown file. There is no behaviour to test and no code to exercise.
  • Generated programmatically from the preset artifact rather than retyped, so the shared content is
    identical to the source of truth rather than a paraphrase.

This package had no .github/copilot-instructions.md, so nothing in the repository carried the fleet working agreements. The file is generated from the preset source of truth in webware-tools with the package title substituted, so it matches what every other package carries.
@codecov

codecov Bot commented Sep 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@tyrsson
tyrsson merged commit aefb526 into 1.0.x Sep 26, 2026
12 checks passed
@tyrsson
tyrsson deleted the docs/agent-working-agreements branch September 26, 2026 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant