研究室でGitHubの使い方がよくわからないという人が多いので、「GitHubをおもちゃにする会」を実施しようと思っています。このリポジトリは、会で説明しようと思っていることをメモしたものです。 このリポジトリは、先輩に言われたことをとにかくメモしたものです。 改善点があれば、このリポジトリにPull Requestを投げるか、issueを立てるかしてください。
参考URL: https://docs.github.com/ja/github/authenticating-to-github/connecting-to-github-with-ssh
- 既存のSSH公開鍵を探す
ls -al ~/.ssh
以下のいずれかのファイル名があれば、公開鍵である。
- id_rsa.pub
- id_ecdsa.pub
- id_ed25519.pub
- ない場合は、SSH秘密鍵と公開鍵のペアを作成する。
ssh-keygen -t ed25519 -C "自分が読んだときにわかりやすいコメント"
いろいろ出てくるが、Enterキーを押し続ける（パスフレーズが必要な場合は設定すること）
- 公開鍵を入手
cat ~/.ssh/id_ed25519.pub
- GitHubにログインし、Settingsを開く
- SSH and GPG keysをクリック
- New SSH keyをクリック
- Titleに自分にとってわかりやすい名前、Keyに3.で見れた中身をコピペ
- Add SSH keyをクリック
- Emailsをクリック
- Primary email addressの部分に以下の表記がある。
*******+shu1oka28@users.noreply.github.com will be used for web-based Git operations,
数字+user_id@users.noreply.github.comをコピーする。コピーした文字列は、GitHubでEメールアドレスとして使う。これにより、自分の本来のメールアドレスを隠すことができる。この資料では、以後、noreply.github.comで終わるメールアドレスのことを匿名用メールアドレスと呼ぶ。
- Gitに登録する
git config --global user.email "匿名用メールアドレス"
git config --global user.name "GitHubのユーザID"
- 余裕があったらGPGキーの追加もやってほしい.
- 最初にforkして、自分のアカウントにプロジェクトをつくる。
git clone (forkしたプロジェクトのURL)git remote add upstream (fork元のプロジェクトのURL)
- 作業開始前にみんなの作業結果をダウンロード
git fetch upstream
git merge upstream/main
なにかエラーが出た場合は、エラーがでたファイルを開いて、おかしい部分を正しく直してください。
エラーの原因は、自分以外の人が自分と同じファイルを編集してしまったことであることが多いです。このとき、エラーが起きたファイルには、2人の編集内容が並べて書かれています。どっちを採用するかを決めて、いらない方を消すか魔改造するかしてください。
-
プログラム書いたり、作業をする。
-
一区切りついたら、作業結果をフォークしたプロジェクトにアップロードする。
git commit -a -m "いい感じに編集しました！"
git push origin main
- Pull Requestをつくる
- (だれかが) Mergeする