raira-eps/github-slideshow

Your first contribution

Closed this issue · 3 comments

github-learning-lab commented

GitHubフローの紹介

さてイシューに慣れてきたところで、このイシューを使ってあなたの初めてのコントリビュートの道筋をたどってみましょう。

プロジェクトによってコントリビュートのフローは異なりますが、GitHub上で最もシンプルで最も効率的なコントリビュートのやり方はGitHubフローです。

📺 ビデオ：GitHubフローを理解する

以下を読み進めて、次のステップに移りましょう

github-learning-lab commented

ステップ４：ブランチを作ろう

GitHubフローの最初のステップに取り掛かりましょう：つまりブランチの作成です📖。

ブランチの作成

ブランチの作成

📺 Video: Branches

さて、GitHubフローの最初のステップとしてブランチの作成方法を学びました。

ブランチを作ることによってmasterブランチからあなたの作業を分離することができるため、ブランチはGitHubフローにおいて重要な役割を果たします。言い換えれば、誰もが安全な場所でコントリビュートを始めることができるのです。

ブランチを使う際のコツ

１つのプロジェクトの中にブランチは何百と作成され、それぞれがmasterブランチへの変更の提案となります。

これらのブランチをチーム全体で管理可能な状態を保つには一つ一つのブランチを完結で短命に保つことが必要です。言い換えると、１つの新しい機能か１つのバグフィックスごとに１つのブランチを作成するべきです。こうすることで、ブランチがmasterブランチにマージ 📖 されるまでのアクティブな期間を数日に保つことができ、他のコントリビューターが混乱する可能性を減らすことが出来ます。

⌨️ やってみよう：初めてのブランチ

  1. Codeタブに移動しましょう
  2. Branch: master ドロップダウンをクリックしましょう
  3. 入力フィールドに、例えばmy-slideのように、作成するブランチの名前を入力しましょう
  4. Create branch: をクリックするか、"Enter"キーを押し、ブランチを作成しましょう

このリポジトリで新しいブランチが作成されたら、新しいコメントを書き込みます。

github-learning-lab commented

ステップ５：ファイルをコミットしよう

🎉 ブランチを作成できました！

ブランチを作成することで、masterブランチに変更を加えることなくプロジェクトへの修正を行うことができるようになります。さて、ブランチの作成が完了したので、次はファイルを作成し、初めてのコミットを行いましょう！

コミットの基礎

コミットの基礎

GitHub上で新しいファイルを作成したり、ファイルの修正をし終えたら、ページの下にスクロースしましょう。"Commit new file"セクションが見つかるはずです。

最初のフィールドにはコミットメッセージを入力します。コミットメッセージでは、このファイルに対して行った変更を他の人に完結に伝える必要があります。

コミットメッセージを書く際の決まり：

  • コミットメッセージの終わりにピリオドは付けない
  • コミットメッセージは５０文字以内とする。必要であれば、詳細な情報は追加の詳細フィールドに記載する。これはタイトルのラインのすぐ下にあるフィールドです
  • 現在形を使う。例えば、「追加した」の代わりに「追加する」を書いたり、「マージした」の代わりに「マージする」と書く
  • ファイルを変更する上での意図を書く

⌨️ やってみよう：初めてのコミット

下記の手順に従うことによって、GitHub上に変更をコミットすることが出来ます。

  1. このブランチに新しいファイルを作成しましょう。_postsフォルダーに0000-01-02-raira-eps.mdという名前のファイルを作成します。このリンクをクリックするか、以下の手順でファイルを作成することが出来ます：
    • "Code"タブに戻る
    • ブランチドロップダウンにて、"my-page"を選択
    • Create new fileをクリック
    • "file name"フィールドに_posts/0000-01-02-raira-eps.mdと入力する。ファイル名の中に/を入れることで自動的にそのファイルを_postsディレクトリに保存することが出来ます。
  2. ファイルの名前を入力したら、以下の内容をファイルに追加する： 
    ---
layout: slide
title: "２枚目のスライドにようこそ！"
---
何かを書く。
戻るには戻るボタンを使いましょう！
  3. テキストを追加後、ファイル編集ビューのすぐ下にあるテキスト入力フィールドにコミットメッセージを入れることで、この変更をコミットすることが出来ます。コミットメッセージのガイドラインとしては、手順のすぐ上にあるコミットの基礎を参照してください。
  4. コミットメッセージを入力したら、Commit new fileをクリック

このブランチに新しいコミットが行われたら、追加のコメントを書き込みます。

github-learning-lab commented

ステップ６：プルリクエストを作ろう

コミットの作成に成功しました ✨

コミットの作成が完了したので、次にプルリクエストによって変更を提案してみましょう！イシューでは他のメンバーと議論をすることが行われますが、プルリクエストではあなたが行った変更を共有し、その変更についてのフィードバックをもらい、完璧になるまでそれを繰り返すのです！

プルリクエストとはなにか？

プルリクエスト

GitHubフローを思い返してみましょう。ブランチの作成をし、ファイルを追加し、ブランチにそのファイルをコミットしました。次にこのファイルについて他のメンバーとコラボレートしましょう。プルリクエスト上でコラボレーションを行います。詳細はこのビデオを御覧ください：

📺 ビデオ：プルリクエストの紹介

このプルリクエストは、ブランチに対して行った変更を保持し、masterブランチへ取り込むためのものです。

⌨️ やってみよう：プルリクエストの作成

  1. このリンクをクリックするか、下記手順によってプルリクエストを作成しましょう：
    • "Pull requests"タブから、New pull requestをクリックしましょう
    • "base:"ドロップダウンメニューでは、"master"が選択されている事を確認しましょう
    • "compare:"ドロップダウンメニューでは、"my-page"を選択しましょう
    • "Create pull request"ボタンを押しましょう
  2. ブランチを選択したら、プルリクエストのタイトルを入力しましょう。例えばraira-epsのファイルを追加などです。
  3. 次のフィールドには、行った変更の説明を記載します。ここまでに行ってきたことについて、自由に記載しましょう。ちなみに、ここまででこれらの事をやってきています：ブランチの作成、新規ファイルの作成、コミットの追加、プルリクエストの作成
  4. Create pull requestをクリックしましょう

新しいプルリクエストが作成されたら、そこにコメントを書き込みます