kntrbn / github-slideshow

A robot powered training repository :robot:
https://lab.github.com/githubtraining/introduction-to-github
MIT License
0 stars 0 forks source link

Your first contribution #3

Closed github-learning-lab[bot] closed 3 years ago

github-learning-lab[bot] commented 3 years ago

GitHubフローの紹介

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

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

:tv: ビデオ:GitHubフローを理解する


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

github-learning-lab[bot] commented 3 years ago

ステップ4:ブランチを作ろう

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

ブランチの作成 ## ブランチの作成 :tv: [Video: Branches](https://www.youtube.com/watch?v=xgQmu81G1yY) さて、GitHubフローの最初のステップとしてブランチの作成方法を学びました。 ブランチを作ることによって`main`ブランチからあなたの作業を分離することができるため、ブランチはGitHubフローにおいて重要な役割を果たします。言い換えれば、誰もが安全な場所でコントリビュートを始めることができるのです。 ### ブランチを使う際のコツ 1つのプロジェクトの中にブランチは何百と作成され、それぞれが`main`ブランチへの変更の提案となります。 これらのブランチをチーム全体で管理可能な状態を保つには一つ一つのブランチを完結で短命に保つことが必要です。言い換えると、1つの新しい機能か1つのバグフィックスごとに1つのブランチを作成するべきです。こうすることで、ブランチが`main`ブランチにマージ [:book:](https://help.github.com/articles/github-glossary/#merge) されるまでのアクティブな期間を数日に保つことができ、他のコントリビューターが混乱する可能性を減らすことが出来ます。

:keyboard: やってみよう:初めてのブランチ

  1. もちまだインストールしていないのであればVisual Studio Code (VS Codeと呼ばれます)をダウンロードし、起動しましょう。
  2. VS Codeの中で、コマンドパレットを開きましょう。コマンドパレットを開くには、WindowsではCtrl+Shift+P、macOSではCommand ⌘+Shift+Pを押します。クローンの際にはVS Codeの公式ドキュメントにも手順が記載されています。
  3. git cloneと入力し、Enterを押します。 a screenshot of vs code with the command palette open
  4. 新しいウィンドウにリポジトリのURLを貼り付け、Enterを押します:
      https://github.com/kntrbn/github-slideshow.git
  5. リポジトリを保存する場所を選択し、Choose folder をクリックします。その後、選択したフォルダーを開きましょう。
  6. リポジトリのフォルダーがVS Codeのプロジェクトに開かれているはずです。VS Codeのウィンドウの左下にあるmainをクリックしましょう。Gitブランチに関連するコマンドが表示されたコマンドパレットが表示されるはずです。 a screenshot of the Git branches in VS Code
  7. Create new branch をクリックし、好きなブランチ名を入力しましょう。例えばmy-slideといったものです。その後、Enterを押します。
  8. どのrefからブランチを作成するか尋ねられた場合、mainを選択しましょう。
  9. Source Controlビューに移動し、...をクリックし Push を選択します。ブランチを公開するか尋ねるダイアログボックスを確認しましょう。 a screenshot of the source control view in VS Code

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

github-learning-lab[bot] commented 3 years ago

ステップ5:ファイルをコミットしよう

:tada: ブランチを作成できました!

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

コミットの基礎 ## コミットの基礎 GitHub上で新しいファイルを作成したり、ファイルの修正をし終えたら、ページの下にスクロースしましょう。"Commit new file"セクションが見つかるはずです。 最初のフィールドにはコミットメッセージを入力します。コミットメッセージでは、このファイルに対して行った変更を他の人に完結に伝える必要があります。 ### コミットメッセージを書く際の決まり: - コミットメッセージの終わりにピリオドは付けない - コミットメッセージは50文字以内とする。必要であれば、詳細な情報は追加の詳細フィールドに記載する。これはタイトルのラインのすぐ下にあるフィールドです - 現在形を使う。例えば、「追加した」の代わりに「追加する」を書いたり、「マージした」の代わりに「マージする」と書く - ファイルを変更する上での意図を書く

:keyboard: やってみよう:初めてのコミット

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

  1. _postsフォルダに0000-01-02-kntrbn.mdという名前の新しいファイルを作成しましょう。ファイルのパスは_posts/0000-01-02-kntrbn.mdとなるはずです。
  2. ファイルに以下の内容を追加し、保存しましょう:
      ---
      layout: slide
      title: "2枚目のスライドにようこそ!"
      ---
      何かを書く。
      戻るには戻るボタンを使いましょう!
  3. 新しいファイルをステージに追加するには:Source Controlビューに移動し、ファイルの横にある+ボタンをクリックしましょう。VS Codeの公式ドキュメントにも手順が記載されています。 a screenshot of the staging button in the source control view
  4. テキストフィールドにコミットメッセージを入力し、Windowsの場合はCtrl+Enter、macOSの場合はCommand ⌘+Enterを押すことで変更をコミットしましょう。 a screenshot of the commit message on VS Code
  5. ...をクリックし、Pushを選択しましょう。

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

kntrbn commented 3 years ago

Commited

github-learning-lab[bot] commented 3 years ago

ステップ6:プルリクエストを作ろう

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

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

プルリクエストとはなにか? ## プルリクエスト GitHubフローを思い返してみましょう。ブランチの作成をし、ファイルを追加し、ブランチにそのファイルをコミットしました。次にこのファイルについて他のメンバーとコラボレートしましょう。プルリクエスト上でコラボレーションを行います。詳細はこのビデオを御覧ください: :tv: [ビデオ:プルリクエストの紹介](https://youtu.be/kJr-PIfLDl4)

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

:keyboard: やってみよう:プルリクエストの作成

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

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