実際の仕事で試してください
Voice Type は macOS 用のデバイス上で動く音声入力です。ショートカットを押して話すと、入力中のアプリにテキストが入ります。音声が Mac の外に出ることはありません。7日間無料、その後は 19.99 米ドルの買い切り です（Mac App Store）。サブスクもアカウントも不要です。
無料トライアルを始める何が変わったかは、差分(diff)を見ればわかります。説明文が伝えるのは「なぜ」であり、それは文章です。入力が終わればブランチをマージできるという最後の関門になるため、手を抜かれがちな部分でもあります。
PR特有の挙動:本文があらかじめ入力されている
リポジトリに .github/pull_request_template.md というファイルがあると、PRを開いたときにGitHubがその内容を説明欄に読み込みます。つまり、文書を丸ごと音声入力するのではなく、すでにある見出しの間の空白に音声入力することになります。カーソルの位置を意識して置けば、むしろ楽になります。
- まずテンプレートを読み、話し始める前に、各見出しの下に何を書くか決めます。
- ひとつの見出しの下の空行をクリックして、その節を音声入力し、停止してから次の見出しをクリックします。
- 通しで一気に話さないでください。間違った見出しの下で「new line」と声に出すと、テスト計画が概要の中に埋もれてしまいます。
落とし穴:音声入力した括弧がチェックリストにチェックを入れる
PRテンプレートの多くは、タスクリストで書かれたチェックリストです。「open bracket x close bracket」と音声入力すると、チェック済みのボックスができます。自動補完で余分に入った括弧の組でも同じことが起きます。すべてのボックスにチェックが入ったテンプレートを見たレビュアーは、あなたが確認を済ませたと受け取ります。PRを作成する前に、「Preview」タブで、意図せずチェックされているボックスがないか確認してください。
メンションとIssueの候補表示は、Issueの場合とまったく同じ動きをします。「at」と音声入力するとユーザーの自動補完が開き、「hash」と音声入力するとIssueの選択が開きます。Command+Returnで送信されます。
声で入れるものと、手で打つもの
- 音声入力:変更の動機、アプローチ、受け入れたトレードオフと見送ったトレードオフ、そしてレビュアーに最も注意して見てほしいリスク。すべて文章で書く部分であり、レビューを速くする情報そのものです。
- 音声入力:テスト計画は、まず話し言葉の文として入力し、あとで箇条書きに整えます。
- 手入力:ファイルパス、関数名、フラグ名、バージョン番号、コードブロックの中身。音声では大文字小文字や区切り文字が正しく入らず、識別子が間違っているとレビュアーが別のファイルを見に行ってしまいます。
説明文を音声入力する
- 音声入力を一度オンにします。「システム設定」→「キーボード」→「音声入力」の順に開きます。詳しい手順はmacOSで音声入力をオンにする方法をご覧ください。
- プルリクエストを開き、説明欄を節ごとにクリックして入力位置を決めます。
- その節の文章を音声入力し、カーソルを動かす前に停止します。
- 識別子とコードブロックは手で入力します。
- 「Preview」タブを開いてチェックボックスとメンションを確認し、そのうえで送信します。
まったく入力されないとき
- GitHubはブラウザ上で動くため、マイクの許可はブラウザと音声入力ツールに必要です。「システム設定」→「プライバシーとセキュリティ」→「マイク」で確認してください。
- GitHubだけでなく、どこでも音声入力が動かない場合は、Macで音声入力が動作しないときをご覧ください。
エディタからレビューまで、同じホットキーで
Voice Typeは、キー入力を流し込むのではなく、完成したテキストを一度にまとめて挿入します。そのため自動補完が開くことはなく、同じホットキーがエディタでもターミナルでもレビューのスレッドでも使えます。詳しくはMac向け音声入力をご覧ください。