From bdb83c9817154c724b3cbcce5d370ab3b6a15265 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Fri, 8 May 2026 16:49:25 +0300 Subject: general: T8595: add AGENTS.md (#5) * general: T8595: add AGENTS.md * general: T8595: clean leaked internal references * general: T8595: scrub private-org references from public AGENTS.md --- .github/copilot-instructions.md | 2 +- AGENTS.md | 34 +++++++++++++++++++++++++++++++++- 2 files changed, 34 insertions(+), 2 deletions(-) mode change 120000 => 100644 AGENTS.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 949a29f..be77ac8 120000 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1 +1 @@ -../CLAUDE.md \ No newline at end of file +../AGENTS.md \ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md deleted file mode 120000 index 681311e..0000000 --- a/AGENTS.md +++ /dev/null @@ -1 +0,0 @@ -CLAUDE.md \ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..c860b4a --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,33 @@ +# AGENTS.md + +## Project purpose +A grab-bag of community-contributed VyOS helper scripts: admin tools, build tools, config processors, format converters. Not part of the shipped image — these are external scripts maintained loosely. + +## Tech stack +- Mostly Perl (admin-tools: `dhcpremember.pl`, `ovpnbundle.pl`, `ravpnlist.pl`). +- Other subdirectories carry shell / Python / format-conversion helpers. +- No top-level build system; scripts run standalone. + +## Build / test / run +- No build. Each subdirectory's script is self-contained — read each `README` for invocation. +- No automated tests. + +## Repository layout +- `admin-tools/` — Perl operator helpers (DHCP lease tracker, OpenVPN bundle generator, RA-VPN client lister). +- `build-tools/` — image/build helpers. +- `config-processors/` — config-tree post-processing. +- `converters/` — format conversion. +- `README` — top-level pitch ("contributions welcome"). +- `.github/workflows/` — minimal CI inherited via `vyos/.github` reusables. + +## Cross-repo context +This repo is informal/optional and is not part of the canonical 14-repo build set in an internal repository. Stale by category-§3.10 in the cross-repo audit. + +## Conventions +- Commit / PR title: `component: T12345: description` (Phorge ID expected). +- Default branch `master` (per audit baseline); pre-dates the `current` rename. Light governance — community-driven contributions. +- No mandatory LICENSE in tree at root; treat each script's header as authoritative. + +## Notes for future contributors +- README is one paragraph; per-subdir `README` files are the real docs. +- Stale by audit baseline; if you adopt one of these scripts into the product, fold it into `vyos-1x` rather than evolving it here. -- cgit v1.2.3