Skip to content

docs: Document the rule 'never let personal-fork changes pollute upstream'#6

Merged
numachang merged 2 commits into
mainfrom
chore/clarify-gh-default
May 23, 2026
Merged

docs: Document the rule 'never let personal-fork changes pollute upstream'#6
numachang merged 2 commits into
mainfrom
chore/clarify-gh-default

Conversation

@numachang

Copy link
Copy Markdown
Owner

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):

  • Community respect (top of section) — elevates "never let personal-fork changes land in upstream PRs" to an absolute rule. Personal-convenience tweaks (deploy config, locale tweaks, fork-only preferences) must not be PR'd to upstream.
  • Branch operations — notes that each fresh clone should run gh repo set-default numachang/zmk-studio-tweaks once. Without it, gh pr create defaults to the parent repo when origin is a fork.

Layered defense:

  1. Principle: "self-serving updates must not reach upstream"
  2. Mechanical: gh repo set-default <fork> flips the default base
  3. Habit: always pass --repo numachang/zmk-studio-tweaks --base main to gh pr create

Test plan

N/A — documentation only.

🤖 Generated with Claude Code

numachang and others added 2 commits May 23, 2026 19:00
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>
@numachang numachang merged commit be5af6d into main May 23, 2026
@numachang numachang deleted the chore/clarify-gh-default branch May 23, 2026 10:11
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.

1 participant