summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-08 21:27:40 +0300
committerGitHub <noreply@github.com>2026-05-08 21:27:40 +0300
commitf1e00c85fea01b805e0b4f86aed014ccf4fae00e (patch)
treeb0725b0ffdac9b18402c9cbf813ed4602c5ed098 /.github
parent29aac3de8d3b222ee3644ba1a192daaa765adbf7 (diff)
downloadvyos.vyos-f1e00c85fea01b805e0b4f86aed014ccf4fae00e.tar.gz
vyos.vyos-f1e00c85fea01b805e0b4f86aed014ccf4fae00e.zip
general: T8595: add AGENTS.md (#472)
* general: T8595: add AGENTS.md * general: T8595: clean leaked internal references * general: T8595: restore eaten spaces in shell command examples * general: T8595: correct CI scope (no integration in CI yet) and version-matrix attribution * general: T8595: add changelog fragment + refine CI scope (unit-galaxy/unit-source) * general: T8595: address Copilot review threads on test command and commit convention - Line 15: add `ansible-test units` alongside the existing pytest command; the two correspond to the unit-galaxy and unit-source CI jobs respectively, so documenting both gives contributors accurate options for each CI path. - Line 30: change "Commit / PR title" to "Commit headline". No workflow in this repo enforces PR title format; the PR template checklist confirms only commit headlines must carry a Phorge task ID. 🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to '.github')
l---------[-rw-r--r--].github/copilot-instructions.md50
1 files changed, 1 insertions, 49 deletions
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
index fc25faa1..be77ac83 100644..120000
--- a/.github/copilot-instructions.md
+++ b/.github/copilot-instructions.md
@@ -1,49 +1 @@
-# 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`.
+../AGENTS.md \ No newline at end of file