対象読者
- MDN Web Docsでtypoを見つけた
- MDN Web Docsの変更をやったことがない
- gitを知っている
- GitHubアカウントを持っている
導入
先日MDNであるWeb APIについて調べていましたすると...
変換ミスdesu. 誰か修正してくれないかな～と思いましたがページ下部まで見てみると、どうやらGitHubで修正できるようです。ガイドラインも提示されているので自分でできるところまでやってみようと思いました。
ガイドライン
Simple changes
ガイドラインにいろいろ書いてありますが、今回やりたいことは変換ミスの修正という単純な変更です。ずばりSimple changes という項目があるのでそれを読んでみます。
単一ファイルでタイポのような単純な変更をしたいなら、GitHub UIが最も単純な方法らしいです。
※ガイドラインのTipにはMDNページ下部のSource on GitHubのリンクから、GitHubの対象ファイルが開けるとありますが、そこからさらに鉛筆アイコンで編集画面を開く必要があります。Edit on GitHubのリンクからなら編集画面が開けるのでこの方が楽だと思います。
直接編集できる訳ではなく、リポジトリをフォークしてプルリクエストすることになります。GitHub UIは自動的にフォークして、変更をブランチにコミットしてくれるそうです。
pull request etiquette section
Note: See the pull request etiquette section
とあるので、そちらも見てみましょう。大体以下のようなことが書かれていました。
- PRすると自動テストが実行される。もし失敗したらあなたの責任で解決すること。
- 衝突があればあなたの責任で解決すること。メインブランチをpullして、あなたのブランチにマージし、更新したブランチをあなたのフォークにpushすることで行える。
- 別の方法としてrebaseすることでも行えるが、履歴を書き換えることになり、GitHubからの通知がなくレビュワーを混乱させることになる。
- 各プルリクエストには一つの論理的な変更または、関連する変更をまとめる。大きすぎたり関連のない変更があるとレビューがしにくい。
- 変更が複雑ならなぜ変更が必要なのか説明する。
- レビュワーが閉じたら開きなおさない。
今回のような単純な変更であれば衝突時の解決方法に気を付ければよさそうです。
重複確認
ガイドラインには書いていないようですが、見つけた問題のPRがすでに作成されていないか確認しておきます。
今回のケースなら日本語のtypoなのでis:open label:l10n-ja typoで検索するといいと思います。
今回のケースでは見当たらなかったのでPRすることにしました。
編集手順
リポジトリのフォーク
対象ページ下部のEdit on GitHubをクリックします。するとGitHubが開き、以下のように表示されます
You need to fork this repository to propose changes.
Sorry, you’re not able to edit this repository directly—you need to fork it and propose your changes from there instead.
Fork this repository
Learn more about forks
ガイドラインの説明にあった通り、リポジトリをフォークします。
Fork this repositoryボタンをクリックするだけでフォークできました。
編集
フォークすると編集画面が表示されます。問題の個所を修正して、画面下部にコミットメッセージを入力します。
今回の場合なら「fix typo」でいいと思います。
修正してコミットメッセージも入れたら、Propose changesボタンをクリックします。
プルリクエストの作成
Propose changesボタンをクリックすると変更差分が表示されます。変更内容が想定通りであるか確認します。問題なければCreate pull requestボタンをクリックします。
このリポジトリは日本語に限らないので、日本語話者のレビュワーに見て貰いやすい様にPRタイトルを「fix typo in ja」にしました。
変更内容が単純なので説明文は要らないかもしれませんが「変換ミスを修正」にしました。日本語ページのタイポ修正なので説明文も日本語で問題ないと思います。
タイトルと説明文を書いたら Create pull requestボタンをクリックします。
自動テスト結果を確認する
ガイドラインにもあったように、自動テストが実行されます。
しばらく待ってすべてのテストが通ることを確認します。
Review requested
All checks have passed
This branch has no conflicts with the base branch
と表示されれば問題ないと思います。
※どうやら自動的に l10n-ja ラベルが付与されるようなので、タイトルに「in ja」とか入れなくてもよかったかも知れません。
その後
今回PRしたのはこちらです。無事マージされました。
コミットメッセージ、PRタイトル・説明など、これがベストか分かってないです。他にガイドラインなどあれば教えてください。
いつもお世話になっているMDNに少しでも貢献できたなら嬉しいです。
見ての通り簡単に変更PRが送れるので、もし間違いを見つけたらやってみるといいと思います。