docs: name the fork remote origin, as the docs already assume - #819
Merged
Conversation
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
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
CONTRIBUTING.mdtells contributors togit pull origin mainand push branches toorigin, whileCLAUDE.mdanddocs/github.mddescribedoriginas the read-onlynuxsmin/sysPassupstream andopusas the push remote. Following one document then the other pushed to the wrong place. This settles on the usual fork layout —originis this fork,upstreamis the read-only original.Changes
CLAUDE.md: pull/push examples useorigin; the Remotes note becomesorigin=OpusProjects/sysPass(push here),upstream=nuxsmin/sysPass(read-only)docs/github.md: same for the contribution workflow and the release-tag push, and its remotes sentencedocs/github.md: its commit example still readShort title — what and why, contradicting the<type>: short imperative summaryrule stated two paragraphs below it (docs: adopt the org's<type>: summarycommit convention #816) — now consistentCONTRIBUTING.mdneeded no change; it already assumed this layout.Note
A clone that still names the remotes the old way needs
git remote rename origin upstream && git remote rename opus originto match.