エンジニア・制作会社の方へ

お客さまのお店から「サクなおにつないでほしい」とお願いが届いた方へ。サクなおが何をして、何をしないのか、責任の分け方を1ページにまとめました。

責任の分け方（3行で）

  1. サクなおの責任：店主さまが見本で承認した文字・写真の変更が、そのとおりに入ること。不具合のときは「元に戻す」で、その変更だけを取り消す PR をすぐに入れます。
  2. エンジニア・制作会社の責任：サイトの仕組み（コード・デザイン・サーバー・ドメイン・ビルド・セキュリティ）。サクなおはここに触れません。
  3. 切り分け：「元に戻す」で直ればサクなおの変更が原因、直らなければそれ以外が原因です。サクなおの変更はすべて受付番号つきの PR として履歴に残ります。

サクなおがすること

  • 店主さまが LINE で送った「営業時間を変えて」などの依頼から、変更前の文字と変更後の文字の組（完全に一致する文字の置き換え）を作ります。
  • GitHub のサイトでは、見本を店主さまに送ると同時に「下書きのプルリクエスト」を作ります。ブランチ名は sakunao/受付番号 、題は「サクなお 受付番号：依頼の要約」です。
  • 店主さまが「公開する」を押すと、PR を確認待ちにしてお知らせします（自動マージを選んだ場合はサクなおがマージします）。
  • マージされたら、公開ブランチのファイルに新しい文字が入ったことを確かめてから、店主さまに「公開しました」と伝えます。

サクなおがしないこと

  • 公開ブランチへの直接のコミット、強制プッシュ、ブランチの保護の変更。
  • コード・デザイン・依存関係・設定ファイル・ビルドの変更。< > { } ` $ ; = \ のどれか1つでも増減する置き換えは、仕組みで止めて人の確認に回します。
  • 鍵・パスワードの保管。GitHub App のインストールIDだけを持ち、作業のたびに1時間で切れるトークンを作ります。
  • 店主さまの同意のない変更。承認の前に公開ブランチが変わることはありません。

流れ

  1. 店主さまが管理画面で「接続のお願い」のリンクを作り、あなたに転送します（7日間有効・1回だけ）。
  2. リンクから GitHub App「サクなお」を、対象のリポジトリ1つだけに入れます（Only select repositories）。
  3. 公開に使うブランチと、反映のしかた（エンジニアがマージ／店主の承認で自動マージ）を選びます。
  4. 以後、PR が届きます。気になる点があればブランチに直接コミットしても、コメントして閉じても構いません。閉じた場合は店主さまにサクなおからお伝えします。

GitHub App に求める権限

  • Contents：読み取りと書き込み（ブランチを作り、1ファイルを更新するため）
  • Pull requests：読み取りと書き込み（PR を作り、コメントするため）
  • Issues：書き込み（サクなおの範囲を超える依頼を、依頼書として渡すため）
  • Deployments・Metadata：読み取り（PR のプレビューの URL を店主さまの見本に添えるため）

「直す」と「作る」の線引き

サクなおが引き受けるのは「直す」（既存の文字・写真の差し替え）だけです。新しいページ・セクションの追加、デザイン・機能の変更などの「作る」仕事は、サクなおが店主さまの依頼を整理した依頼書（GitHub の Issue）にしてお渡しします。費用・日程は、店主さまとあなたの間でお決めください。サクなおは紹介料などを受け取りません。

よくある質問

ブランチの保護やレビュー必須の設定はそのままでいいですか。

はい。自動マージを選んでいても、保護でマージできないときはエンジニアの確認待ちになり、店主さまにはそうお伝えします。

文字が JSX やテンプレートの中にあっても大丈夫ですか。

画面に出る文字がそのままソースに書かれていれば対応できます。リポジトリ全体で1か所にだけ出てくる文字でないと、自動では進めません（人の確認に回します）。CMS やデータベースから読み込んでいる文字は対象外です。

接続をやめたいときは。

GitHub の Settings → Applications から「サクなお」を外せば、すぐに何もできなくなります。店主さまにも一言お伝えください。

保守契約の範囲と重なりませんか。

サクなおが受けるのは、多くの保守契約で「軽微な更新」と呼ばれる部分だけです。お店とのご契約の内容に合わせて、反映のしかた（エンジニアがマージする）を選んでいただければ、すべての変更があなたの確認を通ります。

ご不明な点は、info@sbgg.jp までお気軽にどうぞ。