docs: Document the rule 'never let personal-fork changes pollute upstream'#6
Merged
Conversation
Twice we have accidentally opened a PR against upstream `zmkfirmware/zmk-studio` (closed PRs zmkfirmware#172, zmkfirmware#173) because `gh pr create` defaults to the parent repo when `origin` is a fork. `gh repo set-default` writes a local-only `.git/config` entry that flips that default to this fork. Documenting it under branch operations so future clones do not re-trip the same wire. Co-Authored-By: Claude <noreply@anthropic.com>
The fork-internal mistake of opening PRs against `zmkfirmware/zmk-studio` (closed zmkfirmware#172, zmkfirmware#173) reflects a deeper rule that should be stated explicitly: personal-convenience changes — deploy config for our own hosting, locale tweaks, fork-only preferences — must never reach upstream. Anything we send to upstream must be broadly useful to its users, not just to us. Co-Authored-By: Claude <noreply@anthropic.com>
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
Two doc additions to
CLAUDE.md, in response to closed upstream PR #172 and PR #173 (both fork-internal work accidentally pointed at upstream):gh repo set-default numachang/zmk-studio-tweaksonce. Without it,gh pr createdefaults to the parent repo whenoriginis a fork.Layered defense:
gh repo set-default <fork>flips the default base--repo numachang/zmk-studio-tweaks --base maintogh pr createTest plan
N/A — documentation only.
🤖 Generated with Claude Code