T8523: add Copilot custom review instructions (#465)

* Add easy-wins improvement spec for vyos.vyos collection

Covers five phases: formatting compliance, runtime.yml redirect fix,
deprecated feature cleanup, missing unit tests, and template deduplication.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Add implementation plan for easy-wins improvements

15 tasks across 5 phases: formatting compliance, runtime.yml bugfix,
deprecated code cleanup, missing unit tests, template deduplication.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Update spec and plan with architect review corrections

Key changes:
- Defer Phase 5 (template deduplication) to v7.0.0: route_maps
  are not identical, BGP dedup blocked by Python module-level
  scoping, OSPF has fundamentally different command paradigms
- Add .git-blame-ignore-revs step to Phase 1
- Add missing test cases: overridden/rendered for resource modules,
  aggregate/purge/with_address for vyos_vlan
- Fix incorrect claim that version.py LooseVersion is unused
- Add sequential merge requirement to preamble

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* chore: add .worktrees/ and .claude/ to .gitignore

* T8523: add Copilot custom review instructions

Add .github/copilot-instructions.md and path-specific instruction
files under .github/instructions/ to teach Copilot project conventions:
copyright attribution, changelog fragment key selection, test mocking
patterns, required state coverage for resource modules, and module
option description standards.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* T8523: remove copyright instructions from Copilot config

Copyright attribution rules are internal guidance kept in Claude
config, not in Copilot review instructions.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* T8523: remove docs/superpowers files inadvertently included

These spec/plan files came from local main commits that were
pulled in during rebase. They are unrelated to this PR.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* T8523: fix inaccuracies flagged by Copilot review

- CLI quoting: clarify that boolean flags and bare keywords are
  unquoted; only string/address values use single quotes
- Test mocking: describe get_device_data / execute_show_command as
  the primary resource module pattern (used by most existing tests);
  note get_resource_connection_facts approach as an alternative
- modules.instructions.md: broaden applyTo to include meta/runtime.yml
  so redirect guidance fires when that file is edited

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* T8523: fix legacy module mocking guidance in tests.instructions.md

Existing legacy tests use side_effect for run_commands, not
return_value. Updated to describe side_effect as the standard
approach, note return_value as also acceptable for fixed responses,
and clarify that the patched helper varies by module (run_commands
for command/facts/ping, load_config/get_config for vyos_config).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* T8523: fix four more inaccuracies flagged by Copilot review

- CLI quoting: address values in firewall groups are unquoted in
  fixtures; instruct reviewers to align with surrounding fixture
  style rather than flagging all unquoted addresses
- Resource module mocking: add .start()/.stop() calls to the snippet
  so it matches the actual setUp/tearDown pattern in existing tests
- terminal plugin versions: reference README.md instead of hardcoding
  a version list that diverges from README
- changelog fragment: remove stale "copyright headers" claim (that
  section was dropped from the instruction files)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

1 files changed, 49 insertions, 0 deletions

diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
new file mode 100644
index 00000000..fc25faa1
--- /dev/null
+++ b/.github/copilot-instructions.md
@@ -0,0 +1,49 @@
+# Copilot Review Instructions — vyos.vyos
+
+This is the `vyos.vyos` Ansible network collection for managing VyOS devices.
+Namespace `vyos`, name `vyos`, version `6.0.0`. All modules are prefixed `vyos_`.
+
+## Commit and PR standards
+
+- Every commit title must start with a Phorge task ID: `T<number>: description`.
+- Every PR must have exactly one changelog fragment in `changelogs/fragments/`.
+- PR descriptions that state a test count (e.g. "Add 8 unit tests") must match the actual number of test methods in the changed files. Flag mismatches.
+
+## Changelog fragments
+
+Fragments are YAML files under `changelogs/fragments/`. Valid top-level keys:
+
+| Key | Use for |
+|-----|---------|
+| `trivial` | Developer tooling, CI, housekeeping, formatting-only changes |
+| `bugfixes` | Bug fixes |
+| `minor_changes` | New features or user-visible improvements |
+| `major_changes` | Breaking changes |
+| `security_fixes` | Security fixes |
+| `doc_changes` | Documentation-only changes |
+
+Flag any fragment that uses `minor_changes` for what is actually developer tooling (linting, formatting, gitignore, test scaffolding). Those should use `trivial`.
+
+## Module architecture
+
+Two module families:
+
+**Resource modules** (`vyos_interfaces`, `vyos_firewall_rules`, `vyos_bgp_global`, etc.) follow a four-part structure under `plugins/module_utils/network/vyos/`:
+- `argspec/{resource}/` — argument spec
+- `config/{resource}/` — config builder
+- `facts/{resource}/` — facts parser
+- `rm_templates/{resource}.py` — regex/Jinja2 CLI templates
+
+Resource modules support all states: `merged`, `replaced`, `overridden`, `deleted`, `rendered`, `gathered`, `parsed`.
+
+**Legacy modules** (`vyos_vlan`, `vyos_config`, `vyos_command`, `vyos_user`, etc.) do not follow the resource module pattern.
+
+## VyOS CLI conventions
+
+- Set commands: `set interfaces ethernet eth0 address '192.0.2.1/24'`
+- Delete commands: `delete interfaces ethernet eth0 address '192.0.2.1/24'`
+- Quoting varies by context. In general, string values (descriptions, names, ELIN numbers) are single-quoted; boolean flags and bare keywords are not. However, address/prefix values may be quoted or unquoted depending on where they appear:
+  - Quoted: `address '192.0.2.1/24'`, `description 'my-iface'`, `elin '0000000911'`
+  - Unquoted: `address 192.0.2.1` (in firewall groups), `disable`, `mtu-ignore`, `vif 200`
+- When reviewing tests and fixtures, align with the quoting style used by surrounding fixtures rather than flagging a missing quote as an error.
+- Interface types: `ethernet`, `loopback`, `bonding`, `bridge`, `tunnel`, `wireguard`.