diff --git a/README.md b/README.md index 108864f..6f9ce68 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ -## はじめに +## 第1章 はじめに ### コンセプト :tada: さぁ、:octocat:GitHubを学びましょう! :tada: @@ -43,10 +43,8 @@ ### 学ばないこと ここでは、GitHubの使い方に集中するため、まずブラウザ上でGitHubを操作することからはじめます。 -途中から、Gitコマンドも登場しますが、 -最低限で済むように工夫してあります[1](#gitcommand) - - +ターミナルでのコマンド入力は、第5章『自分のマシンで作業してみよう』までは出てきません[1](#gitcommand)。 +まずはじっくり、GitHub の概念を理解することに集中してください。 そもそも、GitHubとGitはどのような関係にあるのでしょうか。 @@ -57,18 +55,18 @@
-## GitHubを5秒で表現すると? +## 第2章 GitHubを5秒で表現すると? チームプレーに必要な全てが詰まったナレッジベースです。 -## 絶対にハズせない三大機能 +## 第3章 絶対にハズせない三大機能 GitHubにはたくさんの機能がありますが、特に重要な機能は3つ— 「バージョン管理」「Issue」「Pull Request」です[2](#bigthree)。 いちばん重要な機能はバージョン管理ですが、ここでは簡単な順に学んでいきましょう。 ### Issueを立ててみよう -Issueを立てるのは簡単です。 +今あなたがこれを Web ブラウザ上で読んでいるのなら、Issueを立てるのは簡単です。 `g i`(Go to Issue)そして`c`(Create)とタイプするだけです。 さて、Issueとは何かの説明をしていませんでした; @@ -106,14 +104,14 @@ Issueの数は、「Issues」タブに常に表示されていますが、 さて、何度か「仕事」という言葉が出てきました。 バージョン管理を学ぶ準備ができたということです。 -## バージョン管理をしてみよう +### バージョン管理をしてみよう さてお気づきの通り、GitHubにはファイルが置かれています[3](#asyouknow)。 (`gc`(Go to Code)とすれば見ることができます)。 ここに見えているファイルはすべて、既にバージョン管理されています。 正しくは、「Gitというバージョン管理システムを使って」バージョン管理されています。 -### バージョン管理システムを使う理由 +#### バージョン管理システムを使う理由 じつは、バージョン管理システムがなくとも、バージョン管理はできます。 @@ -127,7 +125,7 @@ Issueの数は、「Issues」タブに常に表示されていますが、 もっともらしく聞こえる問題点はいくらでも挙がりますが、 一番かんたんかつ重要な問題点は「見た目が汚くなる」です。 -### コミットしてみよう +#### コミットしてみよう バージョン管理システムを導入したプロジェクトでは、 ファイルの変更は全て上書きして構いません。 @@ -158,7 +156,7 @@ GitHub上でコミットするのは簡単です: これらは、GitHub上でファイルを編集したとき、ページ下方に見える二つのメッセージ入力ウインドウに対応しています。 それぞれ入力の仕方を解説します。 -#### 要約の書き方 +##### 要約の書き方 ここは、[ファイルの変更履歴](https://github.com/fra-dev-ops-bu/githubinar_github/commits/master/README.md)を一覧したときに表示されますので、 なるべくきれいに書く必要があります。 @@ -173,7 +171,7 @@ GitHub上でコミットするのは簡単です: 具体的な変更内容は、ファイルの変更差分を見ればわかりますので書く必要はありません。 余談ですが、コミットメッセージを読まなくとも、変更内容の種類を大まかに伝えるための方法として、絵文字の使用も推奨されています(参考: https://medium.com/@sa.nitawaki/enjoy-your-commit-with-gitmoji-c-1eca5fe35143 )。 -#### 詳細の書き方 +##### 詳細の書き方 コミットメッセージには、必要であれば詳細を入力することができます。 ここには、「なぜ」を書いてください。 @@ -204,7 +202,7 @@ Issue側から見ると、その課題が「どのように」解決されたか ブランチコントロールボタンに今作ったブランチ名が表示されているのを確認できたら、自由にファイルを編集してかまいません。 もしよければ、このチュートリアルの読みにくい箇所を書き換えてください。 -## Pull Requestをしてみよう +### Pull Requestをしてみよう Pull Requestとはなんでしょうか。 共同開発者に、変更を提案することです。 @@ -233,22 +231,20 @@ Pull Requestを出すのは簡単です。 ナレッジベースを育てるために、Pull requestのメッセージにも関連するIssue番号を書いてください。 `Resolve #123`と書けは、そのPull requestが承認(mergeといいます)された時に自動的にIssueがcloseされます。 -## 仕事をスムーズにすすめるための補助機能 +## 第4章 仕事をスムーズにすすめるための補助機能 - fork - History - Blame -## 自分のマシンで編集してみよう - +## 第5章 自分のマシンで編集してみよう - Gitの環境構築 - クリックでやっていたことをコマンドでやってみよう - コラム: GitHubとGitの関係は? -## 水研業務のコンテキストから見たGitHub -## 読者の感想 ## Appendix - - 参考サイト - - さらなる学びのために +### 水研業務のコンテキストから見たGitHub +### 読者の感想 +### さらなる学びのために 1: git (reset|revert|rebase|stash|cherry-pick|bisect)は割愛します