ai.ros Asset Store

← GitHub マスター講座 | Lesson 7 / 25
7

2-2 リポジトリを作る

第2章 まずは自分のGitHubを作って動かしてみる

想定学習時間: 8分

GitHubの基本単位「リポジトリ」とは

GitHubアカウントを作成したら、次にリポジトリを作成します。リポジトリはGitHubにおける最も基本的な単位であり、「ひとつのプロジェクトを入れる箱」と考えると理解しやすいでしょう。

これら全てを、プロジェクトごとに分けてリポジトリという「箱」に入れて管理します。

リポジトリ作成時の不安を解消する

GitHubを使い始めるとき、多くの方がリポジトリ作成で次のような疑問や不安を感じることがあります。

しかし、最初のリポジトリ作成は難しく考えすぎなくて大丈夫です。まずは、ご自身の練習用リポジトリをひとつ作成し、簡単なREADMEを書いてGitHubの感覚をつかむことから始めましょう。大切なのは、完璧なプロジェクトを作ることではなく、GitHub上に「自分のプロジェクトの箱」を作る体験をすることです。

リポジトリ作成の主要なステップ

1. リポジトリ名を決める

リポジトリ名は、そのプロジェクトの名前になります。後で内容が分かるような名前にすることが重要です。英数字とハイフンを使った名前が無難であり、URLにも含まれるため、短く、読みやすく、意味が伝わる名前にすると良いでしょう。かっこよさよりも分かりやすさを優先してください。

リポジトリが増えてきた際に、名前だけで中身を判断できるよう、意味のある名前を心がけましょう。

2. Description(説明)を記述する

Descriptionは、リポジトリの短い説明文です。必須ではありませんが、記述しておくことで後から見たときに内容が分かりやすくなります。リポジトリ名だけでは伝わりにくい情報を補完する「看板」のような役割を果たします。

特にAI開発やWeb制作では似たようなリポジトリが増えやすいため、Descriptionに一言添えておくだけで、プロジェクトの区別がつきやすくなります。

3. 公開設定(Public / Private)を選ぶ

GitHubでは、リポジトリを公開(Public)するか非公開(Private)にするかを選択できます。

初心者のうちは、まず非公開(Private)で始めることをおすすめします。人目を気にせず、安心して試行錯誤できるからです。GitHubに慣れてから、見せても良いと思えるものを公開すれば十分です。公開と非公開は、プロジェクトの目的によって使い分けましょう。

4. READMEを追加する

リポジトリ作成画面には、「READMEを追加する」という選択肢があります。初心者は、基本的にREADMEを追加しておくことをおすすめします。

READMEは、そのリポジトリの「説明書」です。プロジェクトの目的、使い方、含まれるファイル、今後の予定などを記述します。最初は立派な内容でなくても構いません。

# GitHub練習用リポジトリ

このリポジトリは、GitHubの基本操作を練習するためのものです。

## やること
- ファイルを追加する
- READMEを編集する
- 変更履歴を見る
- コミットを体験する

READMEがあると、リポジトリを開いたときに説明が表示され、自分が何をしようとしているのかが明確になります。AI開発においても、READMEに目的や使い方が書かれていると、AIがプロジェクトを理解しやすくなり、AIとの連携作業をスムーズに進めることができます。

その他の考慮事項(最初は深く考えなくてOK)

.gitignore

.gitignoreは、Gitで管理しないファイルを指定するための設定ファイルです。一時ファイル、環境ごとの設定ファイル、ログファイル、パスワードや秘密情報など、GitHubにアップロードすべきではないファイルを誤って含めないために使用します。特にAPIキーやパスワードなどの秘密情報は、非公開リポジトリであってもGitHubに直接置くべきではありません。環境変数や専用の管理方法を利用し、「秘密情報はGitHubに置かない」という意識を早めに持つことが重要です。

ライセンス

ライセンスは、そのコードや成果物を他の人がどのように利用できるかを示すものです。公開リポジトリで、他の人にも使ってほしい場合に重要になります。初心者が非公開で練習する段階では、深く考える必要はありません。

最初の練習用リポジトリを作成しよう

最初に意識するのは、次の4つの項目だけで十分です。

  1. リポジトリ名を決める
  2. 説明(Description)を書く
  3. 公開か非公開かを選ぶ
  4. READMEを追加する

例えば、次のような形で作成してみましょう。

これだけで、GitHub上にあなたの最初の「箱」ができます。

リポジトリは「作って終わり」ではない

リポジトリは、ただの箱です。箱を作っただけではプロジェクトは動きません。説明を書き、ファイルを入れ、変更を残していくことで、徐々に意味を持ち始めます。

GitHubに慣れていないうちは、ひとつのリポジトリを何度も触ることが大切です。READMEを編集したり、新しいファイルを追加したり、コードを貼ってみたり、変更履歴を見たりするなどの小さな操作を繰り返すことで、GitHubが単なる画面ではなく、あなたの作業場として見えてきます。

AI開発においても、まずリポジトリを作成するところから始めましょう。AIにコードを書かせる前にプロジェクトの箱を作り、READMEに目的を記述し、AIが生成したコードをそこに入れて変更をコミットする。この習慣は、作業を整理し、効率を高める上で非常に重要です。

リポジトリは、これから何を作るのか、どこまで進んだのか、どんな変更をしたのか、誰と共有するのか、AIに何を任せるのか、といった作業の起点となる場所です。GitHubを使いこなす第一歩は、立派なコードを書くことではなく、まず自分のリポジトリを作ることです。小さな箱で構いません。練習用で構いません。非公開で構いません。大切なのは、GitHub上に自分のプロジェクトの置き場所を作ることです。

人にたとえると

あなたは会社の資料室の管理者になったと想像してください。

新しいプロジェクトが始まるたびに、あなたは専用の保管場所を用意します。利用部門の担当者は、その保管場所にプロジェクトの内容がわかるような名前をつけ、何を入れる場所なのかを短い説明書きで示します。次に、その保管場所を社内全員が自由に閲覧できるようにするか、特定の関係者のみがアクセスできるように鍵をかけるかを決めます。そして、保管場所の中には、プロジェクトの目的や使い方、含まれる資料の一覧などを記した目録を必ず入れておきます。こうして、プロジェクトごとに整理された置き場所が完成します。

保管場所=リポジトリ
保管場所の名前=リポジトリ名
説明書き=Description
閲覧設定=公開設定(Public/Private)
目録=README