変更してみる

サイトを変更する人のためのコマンド。はじめる、直す、見てみる、チェックする、出す。

プルリクエストまで 5 分ほど

プロジェクトのフォルダの中で、1 つずつ打っていきます。日本語で書けば日本語で返ってきます。

毎回使う 5 つ

`/kaeru:start` — 安全な場所をつくる

サイトの最新版を取ってきて、あなたの変更のための新しい作業場所を開きます。このあと何をしても、開発者が同意するまで公開中のサイトには影響しません。

> /kaeru:start

  サイトの最新版を取得しました。
  作業中: 「トップページの見出しを変更」

  どこを変えますか？ /kaeru:edit-text で教えてください

`/kaeru:edit-text` — 変えたいことを伝える

人に話すように書いてください。ファイル名は知らなくて大丈夫です。

> /kaeru:edit-text
> トップページの見出しを「Welcome to Kaeru」にして

  トップページの見出しを、日本語と英語の文言ファイルの中に見つけました。

  変更前:  ようこそ
  変更後:  Welcome to Kaeru

  両方の言語で変更しました。/kaeru:preview で見てみましょう

公開中のサイトのトップページ:

  ┌────────────────────────────────┐
  │                                │
  │   ようこそ                      │
  │   はじめましょう                 │
  │                                │
  └────────────────────────────────┘

同じ仲間があと 2 つあります。/kaeru:edit-image は指定した画像に差し替えるもの、/kaeru:edit-color は色を変えるものです。色は名前で変わります。ボタンを 1 つずつ直すのではなく、サイトのブランド色として使われている場所すべてが一度に変わるので、あとからズレることがありません。

`/kaeru:preview` — 見てみる

自分のパソコンの中でサイトを起動して、ページを開き、画面を見せます。「言いたかったのは少し違った」と気づくのはここです。

> /kaeru:preview

  http://localhost:3000 でサイトを起動しました
  トップページを開いています…

  [スクリーンショット]

  これで合っていますか？

`/kaeru:check` — 自分でおかしな所を見つける

開発者の時間も、あなたの時間も節約するコマンドです。プロジェクトのテストを実行したあと、実際のブラウザでページを見て、変更した所をクリックして、レビューする人が聞くであろうことを確かめます。

> /kaeru:check

  出す前のチェック

    テストと lint ................. ✅ 3 件通過
    ブラウザのコンソール ............ ⚠️  /pricing に hydration の警告が 2 件
    変更した所をクリック ............ ✅ サインインのリンクは /sign-in に移動
    失敗したらどうなる .............. ✅ 文言だけなので該当なし
    毎回呼ばれるか .................. ✅ 文言だけなので該当なし
    自信がない所 .................... 「Welcome」を大文字にするかどうか

  ⚠️ は「出す前に見ておくとよい」という意味で、間違えたという意味ではありません。

  警告を直しますか？ /kaeru:fix

それぞれの行の意味は出す前のチェックで説明しています。

`/kaeru:submit` — レビューに出す

開発者に向けてプルリクエストを開きます。その前にもう一度チェックを実行し、未解決のものがあれば止まるので、うっかりレビューに回ることがありません。マージは絶対にしません。

> /kaeru:submit

  チェックは通りました。プルリクエストを開いています…

  ✅ レビューに出しました
  https://github.com/acme/site/pull/48

  開発者が確認します。プレビューのリンクは数分後にそのページへ
  コメントとして表示されます。

プルリクエストは、エンジニアではなく「読む人」のために書かれます。何を変えたかが1文、見てほしいページ、変更前と変更後、自信がないと言った所、そして技術的な詳細は開発者向けに折りたたまれています。

うまくいかないとき

コマンド	こんなとき
`/kaeru:status`	「私の変更は今どうなっている？」— チェック、レビュー、衝突を、ふつうのことばで
`/kaeru:fix`	チェックが赤くなった。簡単で安全なものは直し、それ以外は開発者へ
`/kaeru:undo`	安全に 1 歩戻る
`/kaeru:resolve`	ほかの人の変更とぶつかった。安全なものは解決し、それ以外は相談へ
`/kaeru:help`	わからないこと全般。やさしく説明して、開発者向けのメモを書きます
`/kaeru:switch`	途中だった別の作業に戻る

> /kaeru:status

  あなたの変更: 「トップページの見出しを変更」

  テスト ....... ✅ 通過
  レビュー ..... ⏳ 開発者の確認待ち
  衝突 ......... ✅ なし

  今できることはありません。確認したら連絡が来ます。

もう 2 つ

/kaeru:check-a11y は、その変更が誰にとっても使いやすいかを見ます。読める色の濃さ、画像の説明、それだけ読んでも意味がわかるリンク。色や画像を変えたあとに実行する価値があります。

/kaeru:learn は練習用の案内です。実際の変更をひと通り一緒に進めるので、本番の 1 回目が「はじめての 1 回目」にならずにすみます。

このプラグインのきまり

マージはしません。main に直接 push もしません。
/kaeru:fix が触るのは、書式・誤字・文言のような簡単で安全なものだけです。本当のエラーは推測せずに止まり、開発者に渡ります。
色はトークンで変わります。どこかの値を手で書き換えることはしません。
すべての変更は、誰かの同意が必要なプルリクエストになります。

On this page