Skip to content

Commit 5bb5829

Browse files
kitsne241kitsne241
committed
全編校正
1 parent cddf1c6 commit 5bb5829

File tree

13 files changed

+170
-50
lines changed

13 files changed

+170
-50
lines changed

‎docs/.vitepress/config.mts‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,14 @@ export default defineConfig({
2222
text: '前編 - Git 個人開発',
2323
link: '/text/chapter-1/',
2424
items: [
25-
{ text: '必要なツール', link: '/text/chapter-1/requirements' },
26-
{ text: 'SSH キーの登録', link: '/text/chapter-1/gitea-ssh' },
25+
{
26+
text: '事前準備',
27+
collapsed: false,
28+
items: [
29+
{ text: '必要なツール', link: '/text/chapter-1/requirements' },
30+
{ text: 'SSH キーの登録', link: '/text/chapter-1/gitea-ssh' }
31+
]
32+
},
2733
{ text: 'CLI と GUI', link: '/text/chapter-1/cli-and-gui' },
2834
{ text: 'リポジトリの作成', link: '/text/chapter-1/make-repo' },
2935
{ text: 'コミットと同期', link: '/text/chapter-1/commit-and-sync' },
@@ -39,9 +45,15 @@ export default defineConfig({
3945
{ text: 'ブランチを生やす', link: '/text/chapter-2/grow-a-branch' },
4046
{ text: 'プルリクエストのマージ', link: '/text/chapter-2/merge' },
4147
{ text: '共同開発の基本', link: '/text/chapter-2/team-development' },
42-
{ text: 'コンフリクトの解決', link: '/text/chapter-2/conflict' },
43-
{ text: 'マージのしくみ', link: '/text/chapter-2/how-merging-works' },
44-
{ text: '大規模開発のすすめ', link: '/text/chapter-2/best-practice' }
48+
{
49+
text: '発展',
50+
collapsed: false,
51+
items: [
52+
{ text: 'コンフリクトの解決', link: '/text/chapter-2/conflict' },
53+
{ text: 'マージのしくみ', link: '/text/chapter-2/how-merging-works' },
54+
{ text: '共同開発のすすめ', link: '/text/chapter-2/best-practice' }
55+
]
56+
}
4557
]
4658
},
4759
{

‎docs/text/chapter-1/branch.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,10 @@ Git リポジトリのファイルに加えられた変更は一つ一つが全
1313
:::info コミットグラフ
1414
このように ○ と ○ 同士を結ぶ線によって変更の履歴を表現した図を **コミットグラフ** と呼びます。情報分野の「グラフ」が一般に「点を線で繋いだ図」を表す言葉だとご存知の方がいるかも知れません。ソース管理タブのボタンのアイコンや Git 自体のアイコンの意匠はこのコミットグラフが元ネタになっています。枝分かれしているように見えるのは後編のネタバレなので一旦見なかったことにしてください。
1515

16-
ちなみに、Gitea のリポジトリのページの左上にある「コミット」ボタンを押してコミット一覧を表示し、さらに「コミットグラフ」ボタンを押すことでもコミットグラフを見ることができます。
17-
18-
![](https://md.trap.jp/uploads/upload_d583c75cd240ba642f51399f9877d69c.png)
16+
ちなみに、リポジトリのコミットグラフは Gitea 上でも見ることができます。探してみましょう。
1917
:::
2018

21-
下の図でマウスのカーソルがある位置、ソース管理の最上部の「README.md 更新…」と出ている部分をクリックすると README.md の 3 行目とその下に赤と緑の帯がついて表示され、よく見ると左端にはそれぞれ「ー」「＋」が表示されています。これは、コミット「README.md 更新」では元々何も無かった 3 行目を「Hello Git!」に書き換えた、ということを表します。
19+
下の図でマウスのカーソルがある位置、ソース管理の最上部の「README.md 更新」と出ている部分をクリックすると README.md の 3 行目とその下に赤と緑の帯がついて表示され、よく見ると左端にはそれぞれ「ー」「＋」と表示されています。これは、コミット「README.md 更新」では元々何も無かった 3 行目を「Hello Git!」に書き換えた、ということを表します。
2220

2321
![](https://md.trap.jp/uploads/upload_6ec811201b16d0614d9f044f31f9cb2f.png)
2422

@@ -43,7 +41,7 @@ Git リポジトリのファイルに加えられた変更は一つ一つが全
4341
:::tip GitHub の名前の由来
4442
この講習会では Gitea を使っていますが、Git リポジトリのホスティングサービスとして第一に著名なのは [GitHub](https://github.com/) でしょう。GitHub の Hub という名前から、ホスティングサービスが港よろしく『**ハブ**』の役割を果たすものだという捉え方が腑に落ちるのではないでしょうか。
4543

46-
ただし、GitHub の命名には「開発者の集い」という意図も含まれていると言われています。
44+
ただし、GitHub の命名には「プログラマが集まる場所」という意味も含まれていると言われています。
4745
:::
4846

4947
GitHub と Gitea は同じ役割を与えられたサービスであるだけに、Web ページの見た目や構造も瓜二つです。強いて言えば GitHub は日本語に対応していないのですが、Gitea を使いこなせるようになれば GitHub の基本的な使い方もある程度は類推できるはずです。

‎docs/text/chapter-1/cli-and-gui.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ MS-DOS が提供していた「文字の入力と表示だけができる」イ
3434

3535
Git は CLI で動作するソフトウェアの一つです。traP、とくに SysAd 班での活動では、CLI で動作するソフトウェアの幾つかに慣れ親しんだり、今まで便利に扱ってきたアプリケーションの中に CLI ソフトウェアを見出したりすることがあるかも知れません。もしあなたがその類のソフトウェアを扱ったことがないならば、Git はその記念すべき第 1 号として触ってみるに相応しいソフトウェアであると言えます。
3636

37-
Git はたとえば以下のようなコマンドによって操作します。最初の `git` が Git に対するコマンドの指定です。Git に限らず多くの CLI ソフトウェアのコマンドは使用するソフトウェアを指定するプレフィクスをつけます。それぞれのコマンドの意味は前編の後半に説明します。
37+
Git はたとえば以下のようなコマンドによって操作します。最初の `git` が Git に対するコマンドの指定です。Git に限らず多くの CLI ソフトウェアのコマンドは使用するソフトウェアを指定する接頭辞をつけます。それぞれのコマンドの意味は前編の後半に説明します。
3838

3939
```sh
4040
$ git clone {リポジトリURI}

‎docs/text/chapter-1/commit-and-sync.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ VSCode を開き、ウィンドウにデスクトップのディレクトリ myd
1818

1919
など。この状態で以下を順に実行してください。
2020

21-
1. カーソルを「変更」の文字の上に持っていき、すぐ右隣に表示される「＋」を押す
21+
1. カーソルを「コミット」ボタンの直下にある「変更」の文字の上に持っていき、すぐ右隣に表示される「＋」を押す
2222
2. その上の入力欄に「README.md 更新」と書き入れて「コミット」ボタンを押す
2323
3. 「コミット」ボタンが「変更の同期 1↑」ボタンに切り替わるので、それも押す
2424

‎docs/text/chapter-1/git-commands.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@
7171
<td style="text-align: center"><strong>commit</strong></td>
7272
</tr>
7373
<tr>
74-
<td>デスクトップの mydrive で「変更を同期」ボタンを押す</td>
74+
<td>デスクトップの mydrive で「変更を同期 ↑1」ボタンを押す</td>
7575
<td style="text-align: center"><strong>push</strong></td>
7676
</tr>
7777
<tr>
78-
<td>ダウンロードの mydrive で「変更の同期」ボタンを押す</td>
78+
<td>ダウンロードの mydrive で「変更の同期 ↓1」ボタンを押す</td>
7979
<td style="text-align: center"><strong>pull</strong></td>
8080
</tr>
8181
</table>

‎docs/text/chapter-1/make-repo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ iCloud Drive や OneDrive では、特定の名前（たとえば「iCloud Drive
4444
![](https://md.trap.jp/uploads/upload_463a69fe38aad51ec9417420d5723876.png)
4545

4646

47-
Git + Gitea でクラウドストレージを作る場合、前に挙げたクラウドストレージと異なり、**同期されるディレクトリはどこでもよい**です。より正確には、あるディレクトリにおいてターミナルを開いて以下のコマンドを実行したとき、そこが同期されるディレクトリになります。
47+
Git + Gitea でクラウドストレージを作る場合、前に挙げたクラウドストレージと異なり、**同期されるディレクトリはどこでもよい**です。より正確には、ターミナル上であるディレクトリに移動して以下のコマンドを実行したとき、そこが同期されるディレクトリになります。
4848

4949
```sh
5050
$ git clone {先ほどの URL}

‎docs/text/chapter-2/best-practice.md‎

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,48 @@
1-
# 大規模開発のすすめ
1+
# 共同開発のすすめ
22

3-
最後に、大規模で責任ある開発においてはコミットメッセージやブランチ名、その他の Git や Gitea の扱いにどんなルールが定められているのか、一般的な例をいくつか紹介します。
3+
最後に、統制の効いた共同開発においてはコミットメッセージやブランチ名、その他の Git や Gitea の扱いにどんなルールが定められているのか、よくある例をいくつか紹介します。
44

5-
言うまでもなく、この章の内容は個人開発や traP の大抵の共同開発においては実践されていない野暮なものです。まずはそんなことを気にせず積極的に開発に参加してみるのがよいと思います。その上で、仕事としての責任ある開発の現場でどんなルールが採用されているのかについて少しでも知っておくと、その知識が普段の開発に何か示唆を与えてくれるかも知れません。
5+
言うまでもなく、この章の内容は個人開発やハッカソンの共同開発においては実践されません。まずはそんなことを気にせず積極的に開発に参加するのがよいです。その上で、責任ある開発の現場でどんなルールが採用されているのかについて少しでも知っておくと、その知識が普段の開発にも何か示唆を与えてくれるかも知れません。
66

7-
:::danger
8-
書くこと募集中です！なぜなら私も知らないので！
7+
:::info Git 講習会中級編
8+
たけのひとさんによって 2024 年度に開催された [Git 講習会中級編](https://q.trap.jp/files/151ef5c6-000e-4477-b767-07cf44fda757) では、プロジェクトやハッカソンのチームリーダー向けにさらに発展的な内容を取り扱っています。興味があればぜひ資料を確認してみてください。
9+
:::
10+
11+
## 接頭辞
12+
13+
コミットメッセージやブランチ名の頭に決まった種類の接頭辞をつけることで、そのコミットやブランチの意図の分類を明確にすることが出来ます。たとえば以下がよく使われます。
14+
15+
<table style="width: 100%; border-collapse: collapse;">
16+
<tr>
17+
<th style="width: auto; text-align: center">接頭辞</th>
18+
<th style="width: 100%;">一般的な意味合い</th>
19+
</tr>
20+
<tr>
21+
<td style="text-align: center"><strong>feat</strong></td>
22+
<td>新機能の追加</td>
23+
</tr>
24+
<tr>
25+
<td style="text-align: center"><strong>fix</strong></td>
26+
<td>既存の機能の問題の修正</td>
27+
</tr>
28+
<tr>
29+
<td style="text-align: center"><strong>style</strong></td>
30+
<td>コードのスタイル変更やフォーマット</td>
31+
</tr>
32+
<tr>
33+
<td style="text-align: center"><strong>docs</strong></td>
34+
<td>ドキュメントの変更</td>
35+
</tr>
36+
<tr>
37+
<td style="text-align: center"><strong>chore</strong></td>
38+
<td>コードやドキュメントに影響しない作業</td>
39+
</tr>
40+
<tr>
41+
<td style="text-align: center"><strong>refactor</strong></td>
42+
<td>リファクタリング（コードの整頓）</td>
43+
</tr>
44+
</table>
45+
46+
:::danger ネタ切れ発生
47+
ここに書くことを募集しています
948
:::

‎docs/text/chapter-2/conflict.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# コンフリクトの解決
22

3-
ひとつのファイルを互いに同期される前に別々の方法で書き換えると **コンフリクト**（競合）が生じることがあります。出会いがちなパターン 2 つについて、試せる解決方法を記します。
3+
ひとつのファイルを互いに同期される前に別々の方法で書き換えると **コンフリクト**（競合）が生じることがあります。出会いがちなパターン 2 つについて、試せる解決方法を記します。この章以降の内容は発展的なものなので、紹介されている操作を実践する必要はありません。
44

55
## マージ競合
66

@@ -20,7 +20,7 @@ mydrive リポジトリで main ブランチから sub ブランチを生やし
2020

2121
![](https://md.trap.jp/uploads/upload_813056da854bdcdec8d46d44a4eae254.png)
2222

23-
main ブランチに直接コミットしながら個人開発をしている時に起きやすいコンフリクトです。
23+
複数のデバイスからリポジトリにアクセスし、main ブランチに直接コミットしながら個人開発をしている時に起きやすいコンフリクトです。
2424

2525
## マージ競合の解決
2626

@@ -30,7 +30,7 @@ main ブランチに直接コミットしながら個人開発をしている時
3030

3131
![](https://md.trap.jp/uploads/upload_44c9575beccfbbe302310bcd06be67e7.png)
3232

33-
次にウィンドウ上部で main を選択します。
33+
次にウィンドウ上部で（マージ元のブランチとして）main を選択します。
3434

3535
:::warning 基本的に直接マージはしない
3636
もしコンフリクトがなかったとすれば、ここまでの操作によって main → sub のマージが実行され、main の変更が sub に反映されます。お察しの通り、もし sub ではなく main にいる状態で逆の操作をすると、**プルリクエストを出すことなく sub → main のマージが実行**されます。
@@ -44,7 +44,7 @@ main ブランチに直接コミットしながら個人開発をしている時
4444

4545
![](https://md.trap.jp/uploads/upload_aee5b36d6370b5d7c8f4d46ff076119e.png)
4646

47-
図のようにエディタ部分が 3 つに分割されます。上 2 つがコンフリクトを起こしている場所の表示で、たった今マージしようとした sub ブランチでの変更は右側「現在のマシン」です。
47+
下図のようにエディタ部分が 3 つに分割されます。上 2 つがコンフリクトを起こしている場所の表示で、今いる sub ブランチでの変更は右側「現在のマシン」です。
4848

4949
sub ブランチでの変更を優先したい場合は「現在のマシン を適用する」を押します。main ブランチでの変更を優先したい場合は「受信中 を適用する」を押します。
5050

@@ -56,7 +56,7 @@ sub ブランチでの変更を優先したい場合は「現在のマシン を
5656

5757
![](https://md.trap.jp/uploads/upload_4401cf0a67b3ae818726a7c490a3208b.png)
5858

59-
先ほどコンフリクトを告げられた Gitea のページをリロードすると、プルリクエストが「マージコミットを作成」可能な状態になっています。
59+
先ほどコンフリクトの発生を告げられた Gitea のページをリロードすると、コンフリクトが解消しプルリクエストが「マージコミットを作成」可能な状態になっていることが分かります。
6060

6161
![](https://md.trap.jp/uploads/upload_29484fdddbddb8d94fab5ae668d0ec10.png)
6262

0 commit comments

Comments
 (0)