baserCMS Documentation

Githubでこのページを編集

Home / 5 / ucmitz / etc / GitHub Projects の利用方法

GitHub Projects の利用方法

プロジェクトの種類

現在、GitHub の Issue を GitHub Projects を利用して4つのプロジェクトに分類しつつ管理しています。

ucmitz3-既存機能移行

baserCMSの既存機能の移行に関するIssue

ucmitz3-API & UnitTest

既存機能の移行に際して発生したユニットテストとAPI開発のためのIssue

ucmitz4

baserCMS5の新機能のIssue

ucmitz ML検討中

上記に当てはまらず、マイルストーンが決定していないIssue

 

Issueの作成

GitHub Projects で Issueを作成すると、どのレポジトリにも紐付いていない、「draft」という状態になります。この時点では、プルリクエストとは紐付ける事ができません。

新しいIssue は、まず、draft として作成しておきます。
そして、「どうするか」が決定したら、レポジトリに紐付いた Issueに変換します。

Issue への変換

  1. draft のタイトルをクリックして詳細画面を開きます。

  2. 「Convert to issue」 をクリックします。

  1. 「ucmitz」をクリックします。そうすると Issue に変換されます。

  1. 状態が「open」なりますので、その次に、「Add milestone」をクリックし、マイルストーンを選択します。

  1. 「Add Labels」をクリックし、ラベルを選択します。

  1. 説明欄に指示や作業内容を入力します。

 

ucmitz3-API & UnitTest

このプロジェクトでは、主に、新しく作成したメソッドや、既存メソッドで動作確認済(@checked)、残作業なし(@noTodo)となっているもののユニットテストの Issue を管理します。

Issue による指示出し

Issue には、ユニットテストが実装できるようにするため、説明欄に指示を書く事を前提とします。
draft から Issueに変換する際には、次を設定してください。

メソッドのヘッダーコメントによる指示出し

現在、ユニットテストの指示について、メソッドのヘッダーコメントに仕様の詳細を記述した上で、それを確認する事を指示としています。

Issue への変換時には、メソッドのヘッダーコメントを見直した上で、Issueの説明欄に「メソッドのヘッダーコメントを確認する」と記載ください。

APIリファレンス化

なお、メソッドのヘッダーコメントについては、後に自動でAPIリファレンス化する予定としています。

ヘルパは、baserCMSのユーザー(制作者)が利用する前提ですので、細かく書いた方がいいですが、それ以外については、特に注意すべき点や特殊な仕様がある場合に書くようにしましょう。

ヘッダーコメントの記述方針

本来はif文の分岐を全部をユニットテストで通すのが良いとされていますので、その全てについて、ヘッダーコメントに記載されいている事が望ましいですが、ユニットテストを実装するにあたり必要な情報が記載されていればOKとします。

また、ヘルパーの @param は参照される頻度が高いので何のパラメータなのかも書きます。

 // 例)
 /**
  * @param int $id コメントID 
  */

なお、コメントの記述については、マイグレーション方針のコメントヘッダー を参考にしてください。

作業の着手

作業担当者は、「Instructed」ラベルのついた Issue より作業に取り掛かります。