仕様: リポジトリ構成
このページは、Sigma リポジトリの構成についての決定事項(正)です。 構成を変えるときは、先にこのページを更新してから、リポジトリへ反映します。 適用は12号からです。
フォルダ構成
Section titled “フォルダ構成”号ごとのフォルダ(例: 12/)の中身は次のとおりです。
_main: 全体結合用のmain.texと、共通設定のstyle.sty_cover/_backcover/_okuduke: 表紙・裏表紙・奥付_img: 号で共有する画像- 学籍番号のフォルダ(例:
sXXXXX): その執筆者の原稿と画像。原則として、自分が触るのは自分のフォルダだけです
文献ファイルは執筆者ごとに分ける
Section titled “文献ファイルは執筆者ごとに分ける”文献ファイルは、号で1本にまとめません。
- 各自が、自分のフォルダに
references.bibを置きます _main/main.texが、全員分を\addbibresourceで読み込みます。結合時に文献は自動で統合されます
理由は、全員が同じ文献ファイルを編集すると競合が頻発するためです。
main.tex への \addbibresource の行追加は、次項のとおり編集担当が行います。
共有ファイルの扱い
Section titled “共有ファイルの扱い”_main/main.texへの行の追加・変更は、編集担当のみが行いますstyle.styは、執筆期間中は変更しません(凍結)。変更が必要な場合は、号替わりなどのタイミングで編集担当が行います- パッケージの読み込みは
style.styで一括して行い、個人のファイルでは行いません(標準パッケージは 執筆ルール に記載)
- ラベルには接頭辞を付けます: 式は
eq:、図はfig:、表はtab:、定理はthm:。続けて、内容が分かる名前を付けます - 画像ファイルは、連番だけではなく内容が分かる名前にします。ファイル名に日本語は使いません
- テキストファイルの改行コードは LF に統一します(リポジトリの
.gitattributesで固定)
ブランチと PR の単位
Section titled “ブランチと PR の単位”- ブランチは、基本は学籍番号ごとです
- ただし PR は、記事・節ごとに小さく切って、早めに main へ入れます。「その人の全作業」を1つの PR にしません
- 1人が複数の記事を書く場合や、共著の場合は、記事単位のブランチにします
PDF はコミットしない
Section titled “PDF はコミットしない”- 個人 PDF や全体 PDF は、Git にコミットしません
- 校正用の PDF は、CI が生成して PR の Artifacts として配ります(仕様: CI)
検討事項(まだ決めていないこと)
Section titled “検討事項(まだ決めていないこと)”- 執筆者がさらに増えたら、フォルダを「人」単位から「記事」単位へ移すか
- 共通テンプレートをリポジトリ直下に1つ置き、各号はそれを複製して始める形にするか