Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
numachang merged 2 commits into from
May 23, 2026
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
673ae52
docs: Note `gh repo set-default` to keep `gh pr create` on the fork
numachang May 23, 2026
c294029
docs: Never let personal-fork changes land in upstream PRs
numachang May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

このフォークは、ZMK プロジェクトの善意の上に成り立っています。次のことを必ず守ってください。

- **「自分のための更新」は、決して upstream を汚さない**: 個人ページへのデプロイ設定、ローカル環境固有の tweak、フォーク限定の好みなど、**上流の利用者一般に価値が無い／関係しない変更**は、絶対に upstream リポジトリへ PR してはいけない。upstream に投げるのは「上流のユーザに広く意味のある変更」だけ。過去 2 回（closed [PR #172](https://github.com/zmkfirmware/zmk-studio/pull/172) / [PR #173](https://github.com/zmkfirmware/zmk-studio/pull/173)）この線を越えた。`gh pr create` を打つ前に base が `numachang/zmk-studio-tweaks` であることを毎回確認する。
- **クレジットを残す**: README / コミットメッセージ / PR 説明で、上流 (`zmkfirmware/zmk-studio`, Apache-2.0) への謝意とリンクを明示する。
- **上流をネガティブに書かない**: 「公式が遅いから」「メンテナが対応しないから」といったニュアンスは避ける。フォークの動機は「個人的な使い勝手の追求」として記述する。
- **upstream に還元する姿勢を保つ**: 機能ができたら upstream にも PR を投げる。取り込まれなくても、投げたという事実が大事。
Expand Down Expand Up @@ -59,6 +60,7 @@

- `main` への直 push は避ける。機能ブランチを切る: `feature/<name>` または `chore/<name>`。
- PR ベースで `main` に入れる（self-merge でも PR を経由）。
- **clone 後に一度だけ** `gh repo set-default numachang/zmk-studio-tweaks` を実行する。`gh pr create` は何も指定しないと **upstream を base に取りに行く**（過去 2 回、誤って `zmkfirmware/zmk-studio` に PR が立った）。set-default はローカル `.git/config` のみ書き換え、push されない。

### コミット

Expand Down