論文執筆・学会発表のための心得
Bitbucketによる論文管理†
Dropboxによる論文管理は容量の問題や詳細な履歴が残らない(=修正された部分を読んで学習する機会を失う)という問題があり,これからは(ソフトウェア構成管理ツールの使い方も学べるということで)GithubもしくはBitbucketで管理しようということになりました.現時点(2014/6/25)ではGithubをプライベートリポジトリとして扱う事ができない(*)ので,さしあたりBitbuketを使う事にします.ただし,Bitbuket自体も色々と制約がありますので,研究室内の運用ルール的なものをまとめておきます.
(*) educationアカウントを取得すればGithubでもプライベートリポジトリを無料で利用できる(京大,マイコン,Githubで検索).面倒くさいのでやってないだけ.
0. 準備†
0.1 Bitbuketとは?†
- wikiれ.http://ja.wikipedia.org/wiki/Bitbucket です.
- 利点:プライベートリポジトリを無料で作成できる
- Githubでは有料.パブリックリポジトリ(無料)の利用が前提のサービス.
- 執筆途中の原稿をパブリックな場で管理するのは適していないので,Bitbuketを利用することにした.
欠点:プライベートリポジトリを共有管理できるのは自分を含めて5アカウントまで.
各自のアカウントで作成したリポジトリをまさおさんと共有するのが簡単だが,まさおさんのアカウントがすぐに上限に達してしまう(=4人の学生しか面倒をみれない).
- アカデミックアカウントになったので共有管理できるアカウントの数が無制限になりました。
- 解決策
- 学生は共用のアカウントを使ってログインする.
- 共用アカウントで作成したプライベートリポジトリをまさおさんと共有する(まさおさんの共有ユーザは一人分増えるだけ).
- 個人アカウントを作成し,共有アカウントのリポジトリをウォッチする(変更等があったことをメールで通知してもらうため)
0.2 研究室共通アカウント†
0.3 個人アカウントを取得しよう!†
- 共通アカウントで作成したリポジトリに対して変更があった時(多くの場合はまさおさんが原稿を修正もしくはサムラゴウチした時)にお知らせを受取る(リポジトリをウォッチする)ため.
- 共通アカウントプライベートリポジトリなので,第三者がウォッチ出来るのかは現在不明.
0.4 GitおよびGUIツールのインストール†
1. 論文管理のための運用ルール†
1.0 リポジトリの作り方†
- 次の手順でリポジトリを作ります(ネーミングは1.1を参照)
- まず共用アカウントでログインする.
- 共用アカウントでリポジトリを作成する.
- 作成したリポジトリの共有メンバにまさおさんと自分を追加する.
- 自分のアカウントにログインしなおす.
- 自分のところに先ほど共有したリポジトリがあるので,そこからクローンしてくる.
1.1 リポジトリのネーミングルール†
- 論文1本につき1リポジトリで管理します.リポジトリを作成する時は以下のネーミングルールに従いましょう.
- 会議の場合:会議名+年_トラック名(あれば)
- Example: ICSE2014とかICSE2014_NIERとか(後者はNIERというフルペーパーではない特別なトラック)
- 同会議に複数人が投稿する場合:リポジトリの名前は,会議名+年として,ディレクトリ(トラック名_研究テーマ名or筆頭著者名)を作成しましょう(Example: ICSE2014/Bug_TriageとかICSE2014/Kashiwaとか)
- ジャーナルの場合:学会名_Journal+年_特集号名or筆頭著者名(Example: IPSJ_Journal_2014_GNとかIPSJ_Journal_2014_Kashiwaとか)
1.2 [重要]コミット/プッシュのタイミング†
- バックアップと進捗状況の共有を兼ねているので,一日一回はmasterにプッシュしましょう.
- ローカルでのコミットは各自任せますが,区切りの良いところでコミットしておくのが良いでしょう(バックアップになります).
1.3 課題/wikiの使い方†
- 使い方はまだあまり決まっていません.課題(issue)はまさおさんが勝手に無理な期日を指定してくるかもしれないので,よく相談しておきましょう.
1.4 共通リポジトリのウォッチ†
- 共通アカウントで作成したリポジトリに対して変更があった時にいち早くお知らせを受取るために,各自のアカウントから共有リポジトリをウォッチしましょう.
ちなみに,メンバーとして共有リポジトリに自分を追加してはいけません(5ユーザ制限のため).
1.5 高度な使い方†
- トピックブランチやプルリクエストといった便利な技が使えるそうですが,今のところ決まり事はありません.
2 その他†
運用ルール等に関して何か気付いた事があれば遠慮なくどうぞ.