メインコンテンツまでスキップ

受講生ページの作成

すべての受講生に作成していただきます。こちらを見ていただけたらイメージしやすいでしょう。 過去学生さんのページの例

前提

  • (TA)新しい受講生の ID 番号をもとに JSON ファイルに追加されたこと
  • (受講生)課題を立ててみよう まで行える状態にあること

目的

COJT でこのようなことを発表しましたという記録を将来に残せること。

手順

Issue を作成する

受講生代表 1,2 名を選出し、「受講生ページの作成」というタイトルで issueを立てる。完了しない限り毎回授業で取り上げる。

春学期

ひとまず、最低限の項目を記載して Markdown ファイルを書き、Github 経由で公開する。

  • 名前
  • 自己紹介文(自由記述)
  • ID 番号(2025SW <番号>)を手元のリポジトリ内の message ディレクトリに保存する。

中途半端な状態でも構わない、一年を通じて完成したらよい。 春学期のうちに手順を理解し、git の扱いに慣れ、秋学期の成果発表会までに滞りなく作成できるための準備をしておく。

秋学期

一年を通じて得たことを振り返り、言語化する。

提出完了の条件

提出は github の Pull request によって行われ、承認されない限りやり直しになります。 必ず TA もしくは講師、もしくは生徒代表の承認を得ること。

スムーズに進めるコツ

git の理解は深いので、ここではなるべく基礎的な git コマンドだけ使えるよう指導します。 できるだけ GUI よりもコマンドラインでまずは体験してください。

ブランチを分けて作業する

近年のソフトウェア開発において、新しい機能追加や修正といった作業は必ずブランチを分けて作業してください。 main ブランチはそのまま本番環境でありそのまま公開されるようになっています。 だから main ブランチに直接コミットやプッシュは禁止としています。

みなさんの名前などを使って他人が見ても分かるブランチ名を作成してそこで作業を行ってください。 例:

git switch -c <taro-yamada>-student-page

ブランチ名にスペースは入れないでください。

差分は極力少なくする

自分の編集したファイルだけ、 git の差分として提出するように心がけてください。ここでは原則、みなさんのファイル 1 枚だけが差分となるはずです。 ファイルを作成し、提出する段階になったら

git status

を実行し、差分がご自身の 1 枚だけの状態を確認します。

git add <該当のファイルパス名>

差分をコミットの対象としました。続けてこの差分ファイルをコミットするためのメッセージを追加します。 コミットというのは簡単に言うと「差分のまとまり」を示します。この先この差分をまとめて巻き戻したいときにコミットを基準に履歴をたどれます。

例:

git commit -m <あなたの名前>の受講生ページを作成した

コミットができたらリモート(ここでは Github )にアップロードするため push します。

例:

git push origin <ブランチ名>

Pull request は常に見ておく

誰かがあなたの Pull request を見て承認(Approved)をすると、あなたに通知がありますので、あなた自身が Merge pull request ボタンを押して、本番環境(main ブランチ)にマージしてください。 待っていても誰もマージしてくれません。

それが終わったら、git コマンドで main ブランチに戻し、リモートから pull してあなたのローカルは最新の状態にしておきます。

git switch main
git pull origin main