とらりもん - GitHubで論文を管理する Diff

{{toc}}

2017/07/05 Jin Katagi

論文をGitHubで管理しましょう。

卒論・修論のフォーマットはこちら（追加予定）
* [[卒論フォーマット]]
* [[修論フォーマット]]

! GitHubアカウントを作る
大学のアドレスでStudents Packに申し込むと、プライベートレポジトリを無料で作れるようになりますので是非。

! ざっくりとした手順
*リモート：GitHub
*ローカル：自分のパソコン

以下、（誰が、どこで作業を行うか）

#リモートレポジトリを作成（自分、リモート）
#ローカルレポジトリとリモートレポジトリを結びつける（自分、リモート）
#1stブランチを切る（自分、ローカル）
#1stブランチからmaster/originブランチにプルリクエストを送る（自分、リモート）
#修正する（自分、ローカル）
#pushする（自分、ローカル）
#修正を繰り返す（自分、ローカル）
#修正点がなくなったら1stブランチをmaster/originにマージする（自分、リモート）
#2ndブランチを切る（自分、ローカル）
#2ndブランチからmaster/originブランチにプルリクエストを送る（自分、リモート）
#共著者（先生）を共編集者に追加する（自分、リモート）
#共著者が修正またはコメントをする（共著者、リモート）
#共著者の修正をローカルに取り込む（自分、ローカル）
#共著者の修正を受け、自分の修正を追加する（自分、ローカル）
#pushする（自分、ローカル）
#修正を繰り返す（自分・共著者、ローカル）

! 詳細な手順
以下を仮定。
* GitHubのアカウント名：hoge
* レポジトリ名:bachelor_thesis


!! リモートレポジトリを作成（自分、リモート）
New Repository → レポジトリ名を入力 → Privateにチェック → Create repository
!! ローカルレポジトリとリモートレポジトリを結びつける（自分、リモート）
$ mkdir bachelor_thesis
$ cd bachelor_thesis
$ echo "# bachelor_thesis" >> README.md
$ git init
$ git add README.md
$ git commit -m "first commit"
$ git remote add origin https://github.com/hoge/bachelor_thesis.git
$ git push -u origin master
$ git remote git://github.com/hoge/bachelor_thesis.git # ローカルをリモートに追随
!! 1stブランチを切る（自分、ローカル）
$ git checkout -b 1st
!! 1stブランチからmaster/originブランチにプルリクエストを送る（自分、リモート）
Pull Requests → New Pull Request → base:master、compare:1st
!! 修正し、push（自分、ローカル）
$ git add hoge.tex
$ git commit -m "xxを修正"
$ git push origin 1st
!! 修正を繰り返す（自分、ローカル）
!! 修正点がなくなったら1stブランチをmaster/originにマージする（自分、リモート）
Pull Request → 1stのプルリクをクリック → Mergeをクリック
!! 2ndブランチを切る（自分、ローカル）
$ git checkout -b 2nd
!! 2ndブランチからmaster/originブランチにプルリクエストを送る（自分、リモート）
Pull Requests → New Pull Request → base:master、compare:2nd
!! 共著者（先生）を共編集者に追加する（自分、リモート）
*レポジトリのSettings → Collaborators → 該当アカウントを追加
!! 共著者が修正またはコメントをする（共著者、リモート）
!! 共著者の修正をローカルに取り込む（自分、ローカル）
$ git fetch upstream # リモートの更新をローカルに反映、この操作はリモートで修正があったらその度に行う
$ git merge upstream/1st upstream/2nd # 更新を取り込む、上と同じく修正毎に行う
!! 共著者の修正を受け、自分の修正を追加し、push（自分、ローカル）
$ git add hoge.tex
$ git commit -m "xxを修正"
$ git push origin 2nd
!! 修正を繰り返す


! 参考
*[[ナウいヤングは論文執筆にGitHubを使う - 文字っぽいの。|http://fromatom.hatenablog.com/entry/2014/02/09/001136]]