From 6f1054a734b74266c7c88646db699dda647538f3 Mon Sep 17 00:00:00 2001 From: Lakshman Patel Date: Tue, 21 Jul 2026 05:17:15 +0530 Subject: [PATCH] docs: add submodule workflow section --- AGENTS.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 1e717128..3e008262 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -219,3 +219,14 @@ This project is indexed by GitNexus as **hawk** (81516 symbols, 253124 relations | Index, status, clean, wiki CLI commands | `.claude/skills/gitnexus/gitnexus-cli/SKILL.md` | + +### Submodule workflow (external/ repos) + +hawk depends on ecosystem repos (`eyrie`, `hawk-core-contracts`, etc.) via git submodules under `external/`. Hawk's `go.work` points to `./external/`, so changes in the submodule are automatically picked up by hawk. + +1. Edit + test in `hawk/external/` — run its tests, run `make test` in hawk +2. Push from the submodule: `git push origin ` +3. Sync to the independent repo: `cd ../ && git fetch origin && git checkout ` +4. PR → merge from the independent repo +5. Pull main in the submodule: `cd ../hawk/external/ && git checkout main && git pull origin main` +6. Commit the pointer in hawk: `cd .. && git add external/ && git commit -m "chore: update "`