From afa709d84ee95c9ae49887e1ad4e5e8e19965118 Mon Sep 17 00:00:00 2001 From: Ewan Croft Date: Thu, 16 Jul 2026 17:38:37 +0100 Subject: [PATCH] docs: add repository agent guidance --- AGENTS.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..469b60d --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,19 @@ +# AGENTS.md + +Guidance for agents working on tangled-sync. This repository is tombstoned; the canonical package is `pkgs/packages/tangled-sync`. Do not resume feature development here unless explicitly requested. + +## Historical behavior + +- `src/check.ts` audits state, `validate-config.ts` validates setup, `test-atproto.ts` probes AT Protocol access, and `index.ts` performs synchronization. +- Sync changes Git/hosting state and may write AT Protocol records; dry-run/check paths must remain non-mutating. + +## Rules + +- Implement maintained fixes in `pkgs` first. Only backport here when the requested outcome includes the archive. +- Preserve repository ownership, visibility, default branches, and remote identity. Never force-push or delete remote content. +- Validate config before any write; redact tokens, SSH material, app passwords, and authorization headers. +- Make retries bounded and operations idempotent so reruns do not duplicate repositories or records. + +## Validation + +For an archival fix run `npm install`, `npm run validate`, `npm run check`, and TypeScript type checking. Exercise sync with mocked APIs or disposable repositories before any live run. `sync:force` is destructive/expansive and is never routine validation. Do not commit configuration secrets or generated state. -- 2.51.2