用語集の翻訳・修正提案を例に、GitHubでプルリクエストを送る手順を解説
(@akipponn さん、ガイド作成ありがとうございます。)
用語集の用語の訳文の変更履歴の管理には、プログラムのソースコードのバージョン管理に利用されることの多いGitHubを利用しています。本記事では、GitHub上で翻訳・修正提案を作成し、送信する方法を説明します。
用語の説明
はじめに、Git/GitHubの用語を説明します。
- リポジトリ: プロジェクトのファイルや変更履歴をためておくデータベースのようなもの、または場所を表します。
- フォーク: 既存のリポジトリを完全にコピーして作られたリポジトリで、自由に変更を加えることができます
- ブランチ: 他の作業に影響を与えずに、新たな変更を加えられる作業スペースです。
- コミット: ファイルに対する変更を記録することです。
- プルリクエスト: 自分が行った変更を元のプロジェクトに取り込んでもらうリクエストです。
初回作業の流れ
- GitHubアカウントの作成: GitHubのアカウントを持っていない場合は、GitHubでアカウントを作成します。
- プロジェクトのリポジトリを開く: GitHub上にあるロストイン・ビットコインのリポジトリを開きます。
- フォークの作成: リポジトリのページの右上にある「Fork」ボタンをクリックすると、自分のアカウントの下にロストイン・ビットコインのリポジトリのフォークが作成されます。
- リポジトリの選択:自分のリポジトリのリスト(https://github.com/<GitHubのユーザー名>?tab=repositories)から、前のステップでフォークしたリポジトリ(https://github.com/<GitHubのユーザー名>/categories)を選びます。
- ブランチの作成: ブランチのドロップダウンメニューをクリックします。新しいブランチ名(例えば、「XXXの翻訳」など)を入力すると、「Create branch: [ブランチ名]」と表示され、クリックするとブランチが作成されます。
- ファイルの編集: 作成したブランチで翻訳したいファイルを選択し、「Edit」ボタンをクリックし、ファイルの内容を編集します。どのブランチで作業しているのかは、画面左のメニューなどで確認できるほか、ファイルのURLでも確認できます。
- コミット: 編集が終わったら、「Commit changes」ボタンをクリックして、メッセージを記入し、変更をコミットします。この段階では、変更は自分のリポジトリのみに保存されます。
- プルリクエストの作成: ロストイン・ビットコインのリポジトリに変更を提案する「プルリクエスト」を送ります。フォークしたリポジトリの「Pull requests」タブで、「New pull request」ボタンをクリックします。
- 変更を加えたブランチを選択し、内容を確認し、「Create pull request」ボタンをクリックします。
- プルリクエストの詳細を記入・送信: プルリクエストのタイトルと詳細を記入し、「Create pull request」ボタンをクリックすると、プルリクエストが送信されます。
初回以降の作業の流れ
- リポジトリの同期: 自分のアカウントの下にフォークしたリポジトリで、「Sync fork」をクリックして、ロストイン・ビットコインのリポジトリと同期します。
- 初回作業の「ブランチの作成」から「プルリクエストの詳細を記入・送信」までを行います。