CONTRIBUTING.md は upstream(herdrdev/herdr)向けの貢献ポリシーです。
このリポジトリでは upstream へ実装 PR を出す予定はありません。 有用な upstream 更新は、必要に応じてこちらへ取り込みます。
以下は CONTRIBUTING の精神を、fork 内部向けに落としたものです。
- GitHub:
kuwa2005 - リモート:
https://github.com/kuwa2005/herdr .github/MAINTAINERS/.github/APPROVED_CONTRIBUTORSに fork 所有者を含める(このリポジトリ上の PR ゲート用)。upstream のメンテナ権限にはならない。
- コードを理解する — 変更の意図・境界・テストが何を保証するかを説明できること。
- 変更は焦点を絞る — 1 コミット / 1 PR 相当で 1 問題。無関係な掃除やリファクタを混ぜない。
- 検証する — コミット前にフックとチェックを通す。
- ドキュメント — ユーザー向けの未リリース説明は
docs/next/。この fork ではルートREADME.mdを日本語メインにしてよい(upstream 同期時は衝突しうる)。 - upstream へ送らない — Issue / Discussion / 実装 PR を
herdrdev/herdrに勝手に開かない。取り込むのは fetch / merge(または rebase)側。
just install-hooksWindows 向けクロスチェックを使う場合(任意):
cargo install xwin --locked
just setup-windows-cross --accept-licensejust ci # PR 相当のチェック
# または
just check # より重い(Windows lint 含む)コミットメッセージは lowercase conventional commits(英語)。Issue 参照は refs #<n>(closing keywords は使わない)。
例:
fix: treat host bs byte as backspace
refs #3244
git remote add upstream https://github.com/herdrdev/herdr.git # 初回のみ
git fetch upstream
git merge upstream/master # または rebase。方針に合わせて選択衝突しやすい箇所の例: README.md、.github/MAINTAINERS、.github/APPROVED_CONTRIBUTORS、distribution/install.*、distribution/latest.json / preview.json、この FORK.md。
リリースバイナリは kuwa2005/herdr Releases から配布する。全 OS(linux / macos / windows)のアセットはこのリポジトリの Releases を指す。
Cargo.tomlのversionを上げてコミットし、masterに push する。- どちらか一方:
git tag vX.Y.Z && git push origin vX.Y.Z- または GitHub Actions の Fork Release を
workflow_dispatchで実行(version=X.Y.Z)
- ワークフロー
.github/workflows/fork-release.ymlが全プラットフォームをビルドし、Release にアップロードし、distribution/latest.jsonを更新してmasterへ push する。
upstream の release.yml は herdrdev/herdr 専用のまま。この fork では使わない。
- まず
AGENTS.mdとこのファイルを読む。 - 認証アカウントが
kuwa2005で、リモートがkuwa2005/herdrなら、この fork 上の実装・コミット・push は所有者作業として進めてよい。 herdrdev/herdrへの実装 PR・機能 Issue は開かない(CONTRIBUTING / AGENTS の外部貢献ガードを維持)。- upstream 由来の再現バグを本家に報告する場合だけ、人間が CONTRIBUTING のバグテンプレート手順に従う。