Skip to content

docs: document fork and upstream workflow - #68

Merged
kartikmanimuthu merged 2 commits into
offloadmemory:mainfrom
fabicarvano:docs/fork-upstream-workflow
Oct 19, 2026
Merged

kartikmanimuthu merged 2 commits into
offloadmemory:mainfrom
fabicarvano:docs/fork-upstream-workflow

Conversation

@fabicarvano

Copy link
Copy Markdown
Contributor

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 from upstream/main, push to origin, PR, keeping the fork's main in sync with --ff-only).
  • CLAUDE.md: Git Workflow section updated.
  • CONTRIBUTING.md: branch creation step now uses upstream/main.
  • README.md: git clone and Discussions/Issues links point to offloadmemory/agentfork.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactor / performance improvement
  • Dependency update
  • CI/CD or build system change

Testing

Not applicable: Markdown-only change. No code, tests, or build configuration were changed. The diff was reviewed manually.

Checklist

  • My code follows the project's style guidelines (N/A: Markdown only)
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas (N/A: no code)
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings (N/A: no code)
  • I have added tests that prove my fix is effective or that my feature works (N/A: no code)
  • New and existing unit tests pass locally with my changes (N/A: no code changed)

@kartikmanimuthu kartikmanimuthu left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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): "origin is github.com:offloadmemory/agentfork.git; a plain git push targets it" — correct for the maintainer clone.
  • Yours: "origin is your fork; upstream is 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,7 still points at kartikmanimuthu/chatbot for Discussions and security advisories. The security one matters most — that's where a vulnerability report is supposed to land.
  • .github/CODEOWNERS:8 still names @kartikmanimuthu.

Approving — thanks for making the contributor path explicit, and for fixing the links rather than just the text around them.

@kartikmanimuthu
kartikmanimuthu merged commit 5507a91 into offloadmemory:main Oct 19, 2026
1 check passed
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.

2 participants