Skip to content

docs(readme): add explicit git-workflow guidance for keeping the graph in sync - #3112

Open
Mohammad-Palla wants to merge 1 commit into
Graphify-Labs:v8from
Mohammad-Palla:docs/keep-graph-fresh-workflow
Open

docs(readme): add explicit git-workflow guidance for keeping the graph in sync#3112
Mohammad-Palla wants to merge 1 commit into
Graphify-Labs:v8from
Mohammad-Palla:docs/keep-graph-fresh-workflow

Conversation

@Mohammad-Palla

Copy link
Copy Markdown

Summary

Adds a clear, step-by-step workflow to the README's "Team setup" section covering how the graph stays in sync with normal git usage:

  • A table mapping each git operation to what graphify does: git commit and git checkout/git switch rebuild automatically via the installed hooks; git pull/git merge requires running graphify update . yourself.
  • Step-by-step setup instructions, including a one-line pull alias (git config --global alias.gpull '!git pull && graphify update .') so keeping the graph current after a pull is a single command.
  • A matching Troubleshooting entry ("Graph doesn't reflect a teammate's recent changes") for anyone who hits this before reading the workflow section.
  • Minor wording fixes to two existing lines that implied broader automatic-rebuild coverage than the hooks actually provide.

Motivation

Several users have reported the graph feeling "stale" after using it for a few days, particularly on large/active repos. In practice this is because commits and branch switches rebuild automatically, but pulling in a teammate's changes does not — so a normal day of git pull-ing quickly drifts out of sync unless graphify update . is run afterward. This makes that step explicit and easy to build into a habit or alias, rather than something users discover only after hitting it.

Test plan

  • Read through the rendered markdown (table + steps + troubleshooting entry) for accuracy against actual hook behavior (graphify/hooks.py: post-commit + post-checkout only, no post-merge)
  • Verified graphify update . is the correct incremental command (matches existing usage elsewhere in the README, e.g. graphify update ./src)
  • Docs-only change, no code touched

…h in sync

Spells out, as a table plus step-by-step instructions, which git
operations rebuild the graph automatically via the installed hooks
(commit, checkout/switch) and which one requires running
`graphify update .` yourself (pull/merge) - with a pull-alias snippet
so it's a single command either way. Adds a matching troubleshooting
entry for when a teammate's changes aren't reflected yet.

@graphify-labs graphify-labs Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Graphify reviewed this change.

Looks safe to merge — no coupling regressions and no blocking issues, checked against the code graph (not a self-assessment).


Graphify review — findings

Documents the recommended team workflow in the README, spelling out that graphify hook install now auto-rebuilds the graph on both commit and branch checkout (and installs a graph.json merge driver), while graphify update . after git pull/git merge is the one manual sync step. Adds a you do/graphify does table, a suggested gpull alias that folds the update into pull, and a troubleshooting entry for graphs that lag behind a teammate's changes, pointing to graphify hook status to verify hooks.

No blocking issues surfaced.

Analysis details — impact, health, verification

Impact & health

Graphify review

Impact — 27 functions depend on the 27 functions this change touches.

Health — grade A; no new coupling hotspots.

Verification — 27 functions in the blast radius were not formally verified this run (proofs are advisory here).

Gate & verification

graphify gate

PASS — objectively clean (no health regressions, tests not run — proofs not run this pass (advisory)). Grounded, not self-assessed.

Advisory (not blocking):

  • verification_scope: 27 function(s) in the blast radius were not formally verified this run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant