Skip to content

docs: add submodule workflow section #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Patel230 merged 1 commit into from
Jul 20, 2026
Merged

docs: add submodule workflow section #108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` |

<!-- gitnexus:end -->

### 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/<repo>`, so changes in the submodule are automatically picked up by hawk.

1. Edit + test in `hawk/external/<repo>` — run its tests, run `make test` in hawk
2. Push from the submodule: `git push origin <branch>`
3. Sync to the independent repo: `cd ../<repo> && git fetch origin <branch> && git checkout <branch>`
4. PR → merge from the independent repo
5. Pull main in the submodule: `cd ../hawk/external/<repo> && git checkout main && git pull origin main`
6. Commit the pointer in hawk: `cd .. && git add external/<repo> && git commit -m "chore: update <repo>"`
Loading