目標
- GitHubにリモートリポジトリを作成し、開発をスタートする
- リポジトリの初期化をシンプルかつクリーンにする
前提
- Gitをインストールしている
- GitHubのアカウント登録が完了している
- GitHubにssh接続が可能な状態になっている
手順
0. 作業用ディレクトリを作成
このようにプロジェクトやごとにディレクトリを切るようにするとわかりやすいかと思います。
(ここは好みです。私はこうしているよ、というだけですね。)
terminal
% pwd
/Users/YOUR-NAME
% mkdir workspace
% cd workspace
% pwd
/Users/YOUR-NAME/workspace
% ls
example-project-A example-project-B
プロジェクトの作業用ディレクトリを作成し、移動。
ここではour-projectと命名します。
terminal
% mkdir our-project
% cd our-project
% pwd
/Users/YOUR-NAME/workspace/our-project
1. GitHubの画面からリモートリポジトリを作成
ホームページまたはマイページのRepositoriesにあるNewボタンをクリックして以下の画面へ。
必須であるリポジトリ名だけ入力すればOKです。ローカルのディレクトリと名前を一致させ、わかりやすくするためにour-projectと命名します。
そのリポジトリを他人に見られたくないならPrivateにしておきましょう。ここではPublic。
下の3つは、チェックなし・None・Noneでいいかと思います(README.mdと.gitignoreはのちに作成すればいいです)。
2. ローカルリポジトリを作成
terminal
% git init
Initialized empty Git repository in /Users/YOUR-NAME/workspace/our-project/.git/
3. リモートリポジトリを登録
HTTPSの場合
terminal
% git remote add origin https://github.com/YOUR-GITHUB-USERNAME/our-project.git
SSHの場合
terminal
% git remote add origin git@github.com:YOUR-GITHUB-USERNAME/our-project.git
登録したリモートリポジトリの確認
terminal
% git remote -v
origin git@github.com:YOUR-GITHUB-USERNAME/our-project.git (fetch)
origin git@github.com:YOUR-GITHUB-USERNAME/our-project.git (push)
4. 最初のコミット ~ プッシュ
最初のコミットはREADME.mdを作成するだけのシンプルなものにします。
コミットメッセージはわかりやすければ何でもいいです("initial commit"とか"最初のコミット"とか)。
terminal
% echo "# our-project" >> README.md
% git add README.md
% git commit -m "first commit"
% git push -u origin master
GitHubのリモートリポジトリを確認すると見出しが追加されたREADME.mdが表示されているはずです。
これでリポジトリの初期化は完了、あとは.gitignoreを適切に設定したり、developやfeatureブランチを切って開発を進めていきます。