コンテンツにスキップ

執筆クイックスタート

環境構築が済んだ人向けに、リポジトリを clone してから最初のプルリクエスト(PR)を出すまでを、通しで体験する手順です。 所要時間は15分ほどを想定しています。

  • 環境構築が完了していること(Git、VS Code、TeX Live 2026 が入り、サンプルのコンパイルが通る状態)
  • GitHub アカウントが数理同好会の Organization に招待され、Sigma リポジトリが見えること

ターミナルで、作業場所にしたいフォルダへ移動してから実行します。 日本語を含むパスや、OneDrive の同期フォルダの中は避けてください。

ターミナルウィンドウ
git clone https://github.com/NITNCmathematicalClub/Sigma.git
cd Sigma

号フォルダ(12号なら 12)の中に、学籍番号の名前の個人フォルダがあります。 編集担当から案内された自分のフォルダへ移動してください。

ターミナルウィンドウ
cd 12
cd sXXXXX

3. 雛形から自分のファイルを始める

Section titled “3. 雛形から自分のファイルを始める”

白紙から書くのではなく、編集担当から案内された雛形ファイル(見出し・定理・証明・図・参考文献入り)をコピーして、自分のファイル名で保存します。 ファイル名の付け方は編集担当の案内に従ってください。

4. コンパイルできるか確認する

Section titled “4. コンパイルできるか確認する”

コンパイルはターミナルから latexmk で行います。 統一設定ファイルが号フォルダ直下に1本だけ置かれているので、-r でそれを明示的に指定します。

ターミナルウィンドウ
latexmk -r ..\.latexmkrc 自分のファイル名.tex

PDF が生成されれば成功です。

VS Code で自分のファイルを開き、本文を1行だけ書き換えて保存し、もう一度コンパイルして PDF に反映されることを確認します。

作業は main で直接行わず、ブランチを切ってから行います。 初回は学籍番号の名前でブランチを切ってください。

ターミナルウィンドウ
git switch -c sXXXXX

(本格的な執筆では、記事や節ごとに小さくブランチを切ります。詳しくは仕様のページを参照してください。)

変更をコミットします。VS Code のソース管理画面から行っても、ターミナルから行っても構いません。

ターミナルウィンドウ
git add 自分のファイル名.tex
git commit -m "クイックスタート: 1行変更して体験"
ターミナルウィンドウ
git push -u origin sXXXXX

GitHub で Sigma リポジトリを開くと、PR を出す案内が表示されます。 「Compare & pull request」から PR を作成し、本文には何をしたかを1〜2行で書いてください。

9. 校正を受けて、マージされたら完了

Section titled “9. 校正を受けて、マージされたら完了”

PR には校正のコメントが付きます。修正したら、そのまま同じブランチへコミットして push すれば、PR に自動で反映されます。 校正が終わり PR がマージされたら、クイックスタートは完了です。お疲れさまでした。