成果発表会(準備)
通例では、ハードウェアコースは年 1 回、ソフトウェアコースを年 2 回、成果発表会を開催します。本学生は必ず発表会に参加することが義務となり ます。
成果発表会資料の事前公開
各作品は、以下の提出フォーマットに従い、指定された方法で Web ページを作成、公開してください。この内容は成果発表会に足を運んでくださる企業担当の方を含め、多くの関係者に対しての案内となるので、絶対に怠ってはなりません。
成果発表会当日以前に公開されていなければなりません。そのために発表会資料は余裕をもって作成しておいてください。
資料作成
成果発表会資料は、講師もしくは TA のレビューを通過して初めて公開されます。 これは開発におけるコードレビューと同様だと思っておいてください、具体的な方法については Github で Pull Request を提出する流れを解説します。
TA による学生 ID の作成
https://github.com/tsukuba-cojt/tsukuba-cojt.github.io/blob/main/src/_data/students_data.json に新しい学生の登録をしてください。 なぜこのようなことをするかというと、学籍番号を外部に漏らすことの影響が計り知れないため、独自にこのサイト内で学生 ID を持たせることにしました。 経緯やディスカッションを経てルールを策定しましたので従って作成してくださいです。
作成場所
成果発表会用のディレクトリ
もし、まだ今期のディレクトリが無かったら、TA が作成します。
https://github.com/tsukuba-cojt/tsukuba-cojt.github.io/tree/main/src/results のディレクトリ内に、今期のディレクトリを作成します。 ディレクトリ名については過去の通例から「2024」といった西暦で命名することにします。
画像用のディレクトリ
学生ページ、成果発表ページで用いる画像は、src > imageに配置にしてください。
学生ページで用いる画像は
image > students > 2024 > { 学生ID}
成果発表ページで用いる画像は
image > results > 2024 > チーム名
に配置してください、
ハードウェアコース、ソフトウェアコース両学科とも同じディレクトリに、成果発表会資料をマークダウン形式で記述し保存します。 マークダウンファイルの冒頭に、fromtmatter と呼ばれる記法でこのページのメタ情報を記述します。HTML ファイルとして公開されるので、 Web サイトでよく見かける title 要素や description 要素など必要な情報だと思ってください。
frontmatter に記述するメタ情報
例として過去の成果発表資料である新たな世界を作る SNS:Ainsなどを見てみると良いでしょう。
冒頭 --- で囲まれた情報が frontmatter です。この中でlayoutとtagsは固定なのでそのまま記述しておいてください。
その他の情報の意味は以下の通りです。
| 説明 | |
|---|---|
| title | 作品タイトル |
| year | 年次 |
| term | ソフトウェアコースのみ春・秋と区別するときに使います。springもしくはautumnもしくは空欄とします |
| icon | アイコンのパス |
| cover | カバー画像のパス |
| description | 要約文です、HTML の meta:description に該当します |
| repositories | [リポジトリの URL](複数ある可能性があるので必ず配列で記載すること) |
| students | [COJT で決められた学生 id] (チームで開発する場合を想定して必ず配列で記載すること) |
ハードウェアコースの必須項目
少なくとも以下の内容は成果発表資料に記載してください。
- 氏名
- 作品名
- 作品詳細
ソフトウェアコースの必須項目
少なくとも以下の内容は成果発表資料に記載してください。
- グループ名
- アプリアイコン
- デプロイ先の URL
- 作品詳細(自由記述)
上記の作品詳細については、ブログの様に文中に動画を埋め込んだりなど、自由に記述できるものとします。
レビュー
Github リポジトリの main ブランチに直接プッシュは許可していません。必ず講師もしくは TA のレビューを通過して main ブランチにマージされ、自動的に公開(デプロイ)されます。 作品資料ができたら、Pull request を提出してください。講師や TA は必ずレビューを行う義務があります。
マージルール
承認されたらMerge pull requestボタンが有効になるので、申請した学生がボタンを押してください。
修正と再提出
何度も修正して再提出は可能です。遠慮なく良い資料に作り直してレビューを受けてください。