summaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorJames O'Doherty <james@theodohertyfamily.com>2026-05-22 09:21:07 -0400
committerJames O'Doherty <james@theodohertyfamily.com>2026-05-22 09:21:07 -0400
commit4c01c88143635cf8b154c936fb0ac6546a509a85 (patch)
tree8d5099874f52c5f311905992b4b05a45666207b4 /AGENTS.md
parent96d75d9f1fab87365d7e6b5070eed3a5757c3484 (diff)
Implement platform compatibility stubs and update AGENTS.md
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/AGENTS.md b/AGENTS.md
index 8f80242..65d75ac 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -43,7 +43,14 @@ To maintain a high-velocity development cycle without sacrificing correctness, w
- **Test Stubs**: Any test that is planned but not yet implementable must use `t.Skip("not implemented")` and include a comment describing the specific scenario the test is intended to verify.
- **Hermetic Configuration**: Tests involving profiles, settings, or filesystem state must not touch the actual user home directory. Use the `ConfigDir` injection pattern in the `App` struct combined with `t.TempDir()` to create isolated, temporary test environments.
-### 3. Testing Strategy
+### 3. Platform Compatibility & Build Constraints
+`wg-wrap` is fundamentally a Linux system tool. To ensure the module remains compilable on other platforms while restricting Linux-specific syscalls, we use the following patterns:
+
+- **Build Tags**: All files interacting with `golang.org/x/sys/unix`, network namespaces, or TUN devices must start with `//go:build linux`.
+- **The Stub Pattern**: For any platform-specific logic in `internal/`, we provide a matching stub file tagged with `//go:build !linux`. This allows the project to compile on non-Linux OSs, returning "not supported" errors at runtime rather than failing at build time.
+- **Platform Agnosticism**: `pkg/` libraries (e.g., `pkg/wgconf`) must remain platform-agnostic and avoid any OS-specific imports to ensure they are reusable across all environments.
+
+### 4. Testing Strategy
We employ a three-tier testing approach to balance speed and reliability:
| Tier | Location | Type | Scope | Requirement |