Skip to content

活動記録の作成方法

Jump to bottom
YutaUra edited this page May 29, 2021 · 3 revisions

活動記録の目的

エンジニアには面倒くさがりで怠惰な人が多く存在します。プロジェクトを動かしている間に熱量が落ちて中途半端な状態で終わることも少なくありません。

活動記録は自分がいつ何をしたか記録することで、サボる行為を浮き彫りにしてくれます。Engineでは活動に参加したしていないを可視化し、モチベーションが継続するようにHPに活動記録を記載しています。プロジェクトを完走させるためにも活動記録を書くことを強く推奨します。

活動記録の粒度

Engineでは、サークル内での活動をクリアにするために活動後の報告をお願いしています。報告して欲しいことは

  1. 定期的なチームでの活動
  2. 不定期なチームでの活動
  3. 不定期なEngine全体としての活動

です。その他の個人レベルのちょっとした作業まで報告する必要はありません。そこまで大変ではないので協力よろしくお願いします。

活動記録の場所

活動記録は全て https://github.com/ycu-engine/ycu-engine.github.io/tree/main/src/data/activity_log にあります。ここにある記録を更新すると自動的にHPにも内容が反映されるようになっており、反映されたものは https://ycu-engine.github.io/activity_log ここから見ることができます。

活動記録を作成・修正する場合は https://github.com/ycu-engine/ycu-engine.github.io/tree/main/src/data/activity_log の中にファイルを追加したり、修正したりする社業と同義となります。

活動記録の書体について

Engine の活動記録はmdxという拡張子で記載されます。mdxはMarkdownの拡張言語のようなもので、Markdownだけでは表現できないことを表現できるようにします。とはいっても、ほとんどがMarkdownなので、まったく心配する必要はありません。

frontmatterについて

frontmatterとはMarkdownファイルの先頭に

---
title: タイトル
author: 作者
---

~内容~

といったように---で囲んだエリアにyaml形式で情報を付加することができます。具体的にEngineの活動記録に利用できるものは以下の通りです。

---
title: タイトル（必須)
date: 日付（必須、例：2021-01-12）
startTime: 開始時刻（任意、19:00）
endTime: 終了時刻（任意、21:00）
teamName: チーム名（任意だが、チームでの活動の場合は必須。例：DataAnalitics, https://github.com/ycu-engine/ycu-engine.github.io/blob/main/src/data/team.ts の teamName の中から選択）
participants: 参加者一覧（任意だが、できるだけ入れて欲しい）
  - 参加者１（ https://github.com/ycu-engine/ycu-engine.github.io/blob/main/src/data/member.ts の memberName の中から選択）
  - 参加者２
  - etc...
topics: 関連する話題（任意）
  - トピック１（ 自由な言葉 )
  - トピック２
  - etc...
---

~内容~

frontmatterの項目には順序はないので、順序が変わっていても問題ありません。具体的な例については https://raw.githubusercontent.com/ycu-engine/ycu-engine.github.io/main/src/data/activity_log/20210112_general.mdx や https://raw.githubusercontent.com/ycu-engine/ycu-engine.github.io/main/src/data/activity_log/20210115_data_analitics.mdx を見てください。

独自コンポーネントについて

mdxにはMarkdownにはない独自の機能を付け足すことができます。具体的な実装については issue や discussion にて聞いてみてください。

現在利用可能な機能は以下の通りです。

個別のユーザーページ・チームページへのリンクへと変換したり等の処理をするので、ユーザーやチームについて言及する際は積極的に利用してください。具体的な使用例に関しては

あたりを確認してみてください。

Markdownに記法について

Markdownの記法についてはこちら(Githubの説明)や、Googleで検索し手調べてみてください。

具体的な作成手順

ステップ0 準備

https://github.com/ycu-engine/community/wiki/Github-and-git-チュートリアル を参考に、

  1. レポジトリのclone
  2. Node.jsとyarnのインストール
  3. エディタのインストール

をしておいてください。

ステップ1 ローカルプロジェクトの最新化

  • git cliを使っている場合 
    git switch main
git pull
  • Github Desktopを使っている場合

ステップ2 新しくブランチを作成する

ブランチ名はfeature/create-activity-log-<日付>-<team名又はgeneral>としてください。

ステップ3 エディターで開く

ステップ4 追加のライブラリをインストールする

ステップ5 活動報告書を作成する

活動報告のファイル名は<日付>-<team名又はgeneral>.mdxとなっている。下の画像を参考にファイルを作成してください。

活動内容など報告書に記載してください。

ステップ6 報告書の内容をプレビューする

書いた内容に表記のズレなどがないかを確認するために一度プレビューしましょう。

VSCodeのターミナルを開いてyarn developと実行してください。

いろいろターミナルに表示されるので、以下の画像のようになるまでしばらく待ちましょう。

その後、 http://localhost:8000/activity_log を開くと、先ほど作成した活動報告が表示されているはずです。表示内容を確認し、適宜修正してください。

ステップ7 PRの作成

作成した内容をGithub Desktopからcommitしてください。わからない場合は以下の画像を参考にしてください。

次に、以下の画像を参考に変更内容をpushしてください。

そして、以下の画像を参考にPRを作成してください。チェックをメンバーの追加・修正ではなく、活動記録の追加・修正に変更してください。

レビューでOKをもらえれば活動報告書の作成は完了です。

おわり

活動報告の作成は慣れれば10分ほどでできるようになるので、欠かさずにやっていただきたいです。また、毎回同じ人が報告書を作成するのではなく、ローテーションのような形で全員で活動報告をするようにできれば良いと思います。

Clone this wiki locally