Repository navigation
docs: document fork and upstream workflow - #68
Conversation
kartikmanimuthu
left a comment
There was a problem hiding this comment.
Thanks @fabicarvano — the contributor workflow itself is accurate and the link update was overdue: the clone URL, Discussions and Issues links in the README really were still pointing at kartikmanimuthu/agentfork. branches from upstream/main, push to origin, PR into upstream is the correct mental model for someone working from a fork, and the --ff-only sync rule is the right guard against a fork's main drifting.
One thing needed before merge: this now conflicts with #62, which rewrote the same two sections (CLAUDE.md § Git Workflow and docs/dev/git-workflow.md) — I verified four conflict regions in the guide and one in CLAUDE.md. Both statements are true, for different people:
- #62 (merged first): "
originisgithub.com:offloadmemory/agentfork.git; a plaingit pushtargets it" — correct for the maintainer clone. - Yours: "
originis your fork;upstreamis the official repo with push disabled" — correct for an external contributor.
Please rebase onto main after #62 lands and write it as a two-role section rather than picking one (the merge plan I'm following has paste-ready text if useful). The important part: CLAUDE.md is injected into every agent working in this repo, so it shouldn't describe remotes that half the clones don't have — keep the canonical summary + pointer there, and the full procedure in docs/dev/git-workflow.md.
Two loose ends the link sweep missed, worth folding in while you're here:
.github/ISSUE_TEMPLATE/config.yml:4,7still points atkartikmanimuthu/chatbotfor Discussions and security advisories. The security one matters most — that's where a vulnerability report is supposed to land..github/CODEOWNERS:8still names@kartikmanimuthu.
Approving — thanks for making the contributor path explicit, and for fixing the links rather than just the text around them.
Summary
Updates contributor documentation for the fork → official repository workflow. The previous guides described a dual push to GitHub and Bitbucket and pointed to a different repository. The remotes are now:
origin= contributor fork (push target)upstream= official repository (read-only, push disabled)It also updates links that pointed to
kartikmanimuthu/agentfork.Changes
docs/dev/git-workflow.md: rewritten for the fork workflow (remote setup, branch fromupstream/main, push toorigin, PR, keeping the fork'smainin sync with--ff-only).CLAUDE.md: Git Workflow section updated.CONTRIBUTING.md: branch creation step now usesupstream/main.README.md:git cloneand Discussions/Issues links point tooffloadmemory/agentfork.Type of Change
Testing
Not applicable: Markdown-only change. No code, tests, or build configuration were changed. The diff was reviewed manually.
Checklist