docs: document fork-based contribution model and make CLAUDE.md agent-agnostic#153
Merged
villelaitila merged 1 commit intosoftagram:mainfrom Apr 8, 2026
Conversation
Adds a "Repository Model (Fork-Based Contribution)" section clarifying that softagram/sgraph is the canonical repo and contributors work via personal forks with origin (fork) + upstream (softagram/sgraph) remotes. Includes the crucial reminder to compare branches against upstream/main rather than just origin/main when reasoning about merge state, since forks can lag behind. Also rewords the header and one internal note so the guidance applies to any AI coding agent (Claude Code, Codex, Gemini CLI, ...) rather than naming Claude specifically. Only the filename follows the CLAUDE.md convention; the content is intentionally generic.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CLAUDE.mdthat documentssoftagram/sgraphas the canonical repo, describes the expectedorigin(personal fork) +upstream(softagram/sgraph) remote layout, and spells out the fork-and-PR workflow recommended for contributors.upstream/main, not justorigin/main— forks can lag behind upstream and give a misleading picture.CLAUDE.mdfilename itself is kept as a de-facto convention.Motivation
While working in a fork, it was easy to misread merge state by only consulting
origin/main— commits that looked unmerged were in fact already live insoftagram/sgraph:main. Writing the convention down prevents that confusion and also onboards new contributors to the fork model without them having to reverse-engineer it from git history.Test plan
CLAUDE.mdon GitHub and verify the new section, table, and code block display correctly.