コンテンツにスキップ

仕様: リポジトリ構成

このページは、Sigma リポジトリの構成についての決定事項(正)です。 構成を変えるときは、先にこのページを更新してから、リポジトリへ反映します。 適用は12号からです。

号ごとのフォルダ(例: 12/)の中身は次のとおりです。

  • _main: 全体結合用の main.tex と、共通設定の style.sty
  • _cover / _backcover / _okuduke: 表紙・裏表紙・奥付
  • _img: 号で共有する画像
  • 学籍番号のフォルダ(例: sXXXXX): その執筆者の原稿と画像。原則として、自分が触るのは自分のフォルダだけです

文献ファイルは執筆者ごとに分ける

Section titled “文献ファイルは執筆者ごとに分ける”

文献ファイルは、号で1本にまとめません。

  • 各自が、自分のフォルダに references.bib を置きます
  • _main/main.tex が、全員分を \addbibresource で読み込みます。結合時に文献は自動で統合されます

理由は、全員が同じ文献ファイルを編集すると競合が頻発するためです。 main.tex への \addbibresource の行追加は、次項のとおり編集担当が行います。

  • _main/main.tex への行の追加・変更は、編集担当のみが行います
  • style.sty は、執筆期間中は変更しません(凍結)。変更が必要な場合は、号替わりなどのタイミングで編集担当が行います
  • パッケージの読み込みは style.sty で一括して行い、個人のファイルでは行いません(標準パッケージは 執筆ルール に記載)
  • ラベルには接頭辞を付けます: 式は eq:、図は fig:、表は tab:、定理は thm:。続けて、内容が分かる名前を付けます
  • 画像ファイルは、連番だけではなく内容が分かる名前にします。ファイル名に日本語は使いません
  • テキストファイルの改行コードは LF に統一します(リポジトリの .gitattributes で固定)
  • ブランチは、基本は学籍番号ごとです
  • ただし PR は、記事・節ごとに小さく切って、早めに main へ入れます。「その人の全作業」を1つの PR にしません
  • 1人が複数の記事を書く場合や、共著の場合は、記事単位のブランチにします
  • 個人 PDF や全体 PDF は、Git にコミットしません
  • 校正用の PDF は、CI が生成して PR の Artifacts として配ります(仕様: CI)

検討事項(まだ決めていないこと)

Section titled “検討事項(まだ決めていないこと)”
  • 執筆者がさらに増えたら、フォルダを「人」単位から「記事」単位へ移すか
  • 共通テンプレートをリポジトリ直下に1つ置き、各号はそれを複製して始める形にするか