Skip to content

GitHowTo

Jump to bottom
SHIBAHARA Hiroki edited this page May 28, 2024 · 1 revision

p5.js website i18n ja project Git リポジトリに関する作業手順など

このガイダンスはgit初心者、または、プルリクエストをやったことがない方を対象にした内容になっております。

すでにgitの使い方をマスターしている方は読む必要はありません(でも、読者ターゲット向けの改善がありましたら、ぜひ改善にご協力ください！)。また、Teamのメンバーの場合はforkするかどうかは個々の判断に任せます。

なお、コマンドラインベースでの操作を記載しておりますので、ここを読んで内容を理解した後は、gitクライアントアプリ(GitHub Desktop, SourceTree, VSCode内のgit機能)の方が便利に作業できると思います！

リポジトリをフォークし、ローカル PC に checkout するまでの流れ(初回のみ)

リポジトリのフォーク

  1. ブラウザで、 https://github.com/p5js-i18n-ja/p5.js-website にアクセスします。

  2. 「Fork」ボタンをクリックし、自分のアカウントにリポジトリをフォークします。
    これにより、あなたの GitHub アカウント上にリポジトリのコピーが作成されます。

フォークしたリポジトリをローカル PC にクローンする

  1. あなたの GitHub アカウントでフォークされたリポジトリにアクセスし、画面右上の「Code」ボタンをクリックします。
    表示される URL をコピーしてください。

  2. 自分の PC で、Visual Studio Code を起動します。
    「ファイル」>「フォルダーを開く」をクリックして、クローン先のフォルダーを選択します。
    クローン先のフォルダーとは、最終的にプロジェクトのフォルダーを [あなたのフォルダ]/projects/p5.js-website/ したい場合は、その１つ上の [あなたのフォルダ]/projects/ です。

  3. Visual Studio Code のターミナルを開き、次のコマンドを実行してローカルにクローンします。

    git clone コピーしたURL

    これにより、あなたのローカル PC 上にリポジトリがクローンがされます。

ローカル PC のブランチ切り替え、最新化

  1. 自分の PC で、Visual Studio Code を起動します。
    「ファイル」>「フォルダーを開く」をクリックして、先ほどクローンしたリポジトリのフォルダを選択します。
    クローンしたリポジトリのフォルダとは [あなたのフォルダ]/projects/p5.js-website/ です。
    以降、プロジェクトフォルダーと呼びます。

  2. Visual Studio Code のターミナルを開き、以降のコマンドを実行して行きます。
    まず、現在のブランチを確認します。

    git branch

  3. i18n/ja ブランチに切り替えます。

    git checkout i18n/ja

  4. リモート(github でフォークしたあなたのリポジトリ)の最新状態を pull します。

    git pull

ファイルを変更する準備(作業の初回のみ)

変更作業を行う前に、新しいブランチを作成します。
これにより、変更が他の作業と衝突することを防ぎます。

  1. Visual Studio Code のターミナルを開き、下記のコマンドで作業用のブランチを作成します。
    ブランチ名は、作業内容がわかる名前を付けてください。

    git checkout -b 作成するブランチ名

ファイルを変更、コミット、リモートリポジトリにプッシュ、プルリクエスト

作業前確認

  1. 作業用ブランチが選択されていることを確認してください。
    Visual Studio Code のターミナルを開き、下記のコマンドで確認できます。

    git branch

    もし作業用ブランチではない場合は、下記のコマンドを実行してください。

    git checkout 作業用ブランチ名

変更、コミット

  1. Visual Studio Code でファイルを開いて、変更作業を行い、保存してください。

    コミットをする単位は１つの事象（機能追加、不具合対応の１つ１つ）毎に行いましょう。一気にたくさんの変更点があるとレビューや修正が大変になりますので！

  2. 変更作業が終わったら、ターミナルで以下のコマンドで変更をステージングし、コミットメッセージを付けてコミットします。

    git add .
git commit -m "変更内容を示すコミットメッセージ"

プッシュ

  1. 上記変更作業・コミットが全て完了したら、あなたの GitHub アカウント上のフォークしたリポジトリにプッシュします。
    ターミナルで以下のコマンドでを実行します。

    git push origin 作業用ブランチ名

プルリクエスト

あなたの変更を元のリポジトリに取り込む（マージ）するために、GitHub にて取り込み要求（プルリクエスト）を送信する必要があります。

  1. あなたの GitHub アカウント上のフォークしたリポジトリにアクセスし、画面上部の「Pull request」タブをクリックします。
    その後、「New pull request」ボタンをクリックし、作成したブランチを選択して元のリポジトリに対するプルリクエストを作成します。

  2. プルリクエストのタイトルと説明を記入し、必要に応じてレビュワーを設定してください。
    また、プルリクエストテンプレートがある場合は、それに従って必要な情報を入力します。
    変更内容や目的、テスト方法など、レビュワーが理解しやすいように情報を提供してください。

  3. 「Create pull request」ボタンをクリックして、プルリクエストを送信します。
    これにより、元のリポジトリのメンテナーやレビュワーがあなたの変更提案を確認できるようになります。

レビューとフィードバック

レビュワーからフィードバックがあった場合、それに対応して変更を加えなければならないことがあります。
必要に応じて、ローカルリポジトリで変更を行い、再度コミットしてプッシュします。
同一の作業用ブランチであれば、プッシュ後、プルリクエストは自動的に更新されます。

プルリクエストのマージ

あなたの作業はありません。
レビュワーからの承認が得られ、変更が問題ないと判断された場合、リポジトリのメンテナーがプルリクエストをマージします。
これにより、あなたの変更が元のリポジトリに取り込まれることになります。

最新化

あなた変更のマージ結果や他の活動者の変更結果などの、元のリポジトリの変更を、あなたのリポジトリに取り込む（上流リポジトリと同期）必要があります。
常に最新に保ちましょう。

詳細は GitHub フォークを同期する を参照してください。

ホーム

参加方法

ガイダンス

リンク

Clone this wiki locally