How to use github projects

This page is still under discussion.

English version will be prepared later.

PEM injection team repository: https://github.com/gw-analysis/detector-characterization

Basic idea

Workflow

  1. 2週間ごと(目安)にミーティングでマイルストーンを設定する。
  2. Githubでissueを適宜作り、"New issue"に入れる(後述のやり方をすれば基本的には自動で入るはず)。issueの作り方は後で詳しく説明。
  3. ミーティング内で、"New issue"にあるissueの内容・優先度("Icebox"か"Backlog"か)を議論し、誰かにアサインする。ミーティング後には"New issue"にissueがなくなるようにする。
    • このときのアサインは、その人がそのタスクをやることを必ずしも意味しない。例えば、ここでアサインされた人が、ミーティングに出ていない誰かに孫アサインしても良い。ただし、その場合は、ミーティングで話されたことを責任をもって伝える。
  4. 新しいマイルストーンが始まった時のミーティングでは"Icebox"も確認し、必要なら"Backlog"に移す。
  5. 取り掛かったら"In progress"にissueを移す。
    • issue内のミニタスクが完了したらチェックボックスをチェックする。
    • "In progress"にあるタスクについてのミーティングでの報告は短めでOK。「このミニタスクが終わりました」とか。なんならいらないかも。
    • 相談事があったらSlackで聞く。generalチャンネルで聞いて、スレッドにし、関係者がコメントできるようにする。必要ならテレコンも開く。
    • 全体ミーティングではあまり細かい話題はしないようにする。
  6. 変更(例えば追加のミニタスクとか)があったらコメントに書いて、本文を更新する。
  7. issueが完了したら(=チェックボックスが全て埋まったら)に"Review/QA"に入れる。
  8. ミーティングで"Review/QA"にあるタスクについて完了報告をし、OKならcloseする(自動的に"Done"に入る)。
    • 完了報告は基本的にはissueの本文を見ながら、あるいはissueから辿れるような形(URLをはるとか)でできるようにしておく。
  9. マイルストーンの期日までに、"Backlog"からissueがなくなるようにする。
  10. 1.あるいは2.に戻りどんどん回していきましょう!

How to make issue

どのようなissueを作るかがプロジェクトの中で最も重要な部分です。以下にissueを作るときの注意点をまとめておきます。これは個人の意見であり絶対ではありませんが参考にして下さい。

How to make new issue in github

ここでは、具体的なissueの作り方を説明します。

  1. githubのレポジトリを開き、さらに上の方にあるissueタブを開く。
  2. 緑色の"New issue"というボタンをクリック。
    • issueを作るほどでもない時はprojectの方からカードを作る。
    • github screen 1

  3. タイトルを付ける(ひとかたまりのタスクの名前:例 コイルの作製)。
  4. 本文に、目的/目標、ToDo(ミニタスク)、参考文献等を書く。このとき、ToDoにはチェックボックスを付けるようにする。テンプレートは後述。

  5. 人をアサインする。issueを作った段階では必ずしもアサインされている必要はないが、"Backlog"等に移動されるタスクにはかならず人がアサインされている必要がある。
    • github screen 1

  6. ラベルを付ける。どのようなラベルをつけるかは後述。
  7. プロジェクトを選ぶ。PEMプロジェクトを選べば自動的に"New issue"に入る。
  8. そのタスクがマイルストーンと関連している時はマイルストーンを設定する。マイルストーンを設定したタスクは、その期日までに必ず完了する。
  9. previewでチェックして大丈夫そうなら、"Submit new issue"をクリックする。
  10. しゅーりょー!

issue本文のテンプレート

必ずしもこれに従う必要はありません。例えば、一人にアサインされた仕事なら「誰が」は書かなくても良い。

## 目的/目標
短く簡潔に書きましょう 
## ToDo
常に最新版になるようにupdateしてね 
- [ ] いつまでに誰が何をするか
- [ ] いつまでに誰が何をするか
- [ ] 完了
## 関連URL/JGW Docs/Files
URL等 
## 完了報告
ミニタスクの報告はここに書く。例えば写真とか測定結果とかを書く。
## その他
なにかあったら書いてね

Label

Reference

  1. https://qiita.com/yoheimuta/items/ddf4b278f3db79ce2a8f

  2. http://tech.cunited.jp/post/150337087525/github

KAGRA/Subgroups/DET/PEMinjection/HowToUseGithubProjects (last edited 2018-02-11 13:02:02 by KojiNagano)