TOC

OpenPNE開発のガイドライン

本WikiにはOpenPNE開発のガイドラインに関する、概要説明や仕様などの確定した情報を記載 しています。

安定版リリースガイドライン

リリーススケジュール

• 原則として、月一リリースとする
• リリース日は第３水曜日（仮）
• 緊急のバグが見つかった場合は、上記日程に関係なく緊急リリースをおこなう

機能追加条件

• リリース2週間前までに開発版としてリリースされている（コミットだけではダメ）
• DB構造変更の必要がない
• 安定動作に支障がないと判断されたもの

メンテナンス期間

メンテナンス期間は2つ先の安定版のbetaリリースまで（例：2.6系のメンテナンス期間は、2.10beta1のリリースまで）

開発版リリースガイドライン

• βはメジャーバージョンアップの1ヶ月前までにリリースする
• βは機能追加FIX
• 最終RCはメジャーバージョンアップの1週間前までにリリースする
• 最終RCは既存の報告されているバグをすべてつぶしたものをリリースする
• beta版以前はpatchを作成しない

チケット作成ガイドライン

チケット作成ショートカット

enhancement	defect
要望チケット作成	バグ報告チケット作成

フォーム記入内容

チケットは以下のような設定で作成する

フォーム名	要望リクエスト	バグ報告	バグ修正 （バグ報告が確認され次第、修正に変更される）
Your email or username	ログイン名が入るため、変更しない	ログイン名が入るため、変更しない	ログイン名が入るため、変更しない
Short summary	要望の要約	発生した現象の要約	修正する不具合の要約
Type	enhancement	defect	defect
Full description	フォーマットに沿って要望の内容を記述する。	フォーマットに沿って要望の内容を記述する。	フォーマットに沿って要望の内容を記述する。
Priority	変更しない（minor）。 仕様策定・実装の段階で変更	変更しない（minor）。 現象確認の段階で変更	バグの緊急度にあわせる
Component	内容に合うcomponentを選択	内容に合うcomponentを選択	内容に合うcomponentを選択
Keywords	「（開発版バージョン）要望」と入れる （現在は「2.11要望」）	「再現待ち」と記入	安定版対応の場合、同時に対応する旧安定版のバージョン
Cc	空欄	空欄	空欄
Milestone	次期安定版 （現在では「OpenPNE2.12」）	選択しない	対応するバージョン
Version	空欄	同じ現象が発生し得るバージョン	同じ現象が発生するバージョン
Assign to	空欄	空欄	空欄

Descriptionフォーマット

チケットのdescriptionは以下のフォーマットにあわせる

【要望リクエスト】

=== ■概要 ===
ここに要望の概要を記入

=== ■仕様 ===
仕様がある場合、仕様を記入
（決まっていなければ=== ■仕様 ===のみでかまわない）

=== ■関連情報 ===
報告元へのリンク・仕様書・関連するチケットなどの補足情報を記入

【バグ報告】

=== ■現象 ===
発生した現象を記入

=== ■発生バージョン ===
バグが発生したバージョンを記入

=== ■再現手順 ===
バグを再現するための手順を記入
（手順をかきようがない場合は空欄でかまわない）

=== ■環境 ===
バグが発生した環境を記入
 * OS
 * ブラウザ
 * 携帯キャリア・機種
 * サーバ環境
など

=== ■関連情報 ===
報告元へのリンク・関連するチケットなどの補足情報を記入

【バグ修正】

=== ■現象 ===
発生した現象を記入

=== ■原因 ===
バグが発生した原因を記入

=== ■修正内容 ===
修正内容を記入

=== ■関連情報 ===
報告元へのリンク・関連するチケットなどの補足情報を記入

重複確認

要望リクエスト・バグ報告をする前に既存のチケットを確認して、重複を出来るだけ避けること。

	要望リクエスト	バグ報告	バグ修正
チケット一覧	[report:52 要望チケット一覧] [report:61 2.11開発開始時から寄せられた要望一覧]	[report:26 再現待ちチケット一覧]	[report:31 2.8.xチケット一覧] [report:35 2.10.xチケット一覧] [report:57 2.11.xチケット一覧]

Type選択基準

【defect】（不具合）

サポートされているバージョンで発生していて、 かつ発生している全てのバージョンで対応する不具合

【enhancement】（拡張）

開発版のみで対応する改善、 または要望。

【task】（タスク）

enhancement・defectチケット対応に関連する作業、 またはdefectにもenhancementにも属さない作業

---

【taskの使用例】enhancementチケット対応に関連する作業

• #1711 au携帯のメール投稿絵文字投稿機能を追加（enhancement）
  • 関連チケット：#1534 AU携帯絵文字投稿機能対応コードの取り込み（task）

priority基準

blocker	緊急リリースが必要
critical	次回リリースで必ず対応（見送り不可能）
major	次回リリースで対応予定（見送り可能）
minor	対応未定
trivial	把握しておく

version選択基準

versionはバグの発生しているバージョンの確認に使用する

【バグ報告時】

そのバグが発生し得る全てのバージョンを入れる （バグが発生した機能が入っている全てのバージョン）

【バグ確認後】

そのバグが発生している全てのバージョンを入れる。 対応する場合はversionに入っている全てのバージョンを修正する

【enhancement】

versionは使用しない

Component選択基準

component	対応プロジェクト	説明
pne-admin	管理画面プロジェクト	管理画面に関わる内容に使用
pne-api	API開発プロジェクト	API開発に関わる内容に使用
pne-biz	PNEBIZプロジェクト	PNEBIZ機能に関わる内容に使用
pne-kansai	PNE関西	PNE関西に関わる内容に使用
pne-ktai	PNEKtaiプロジェクト	携帯版の全般に関わる内容に使用
pne-masterslave	MasterSlavePNE	MasterPNE，SlavePNEに関わる内容に使用
pne-opensocial	OpenSocial情報	OpenPNEの!OpenSocial化に関わる内容に使用
pne-postgresql	PostgreSQLプロジェクト	OpenPNEのPostgreSQL対応に関わる内容に使用
pne-website	OpenPNEWEBサイト	OpenPNE関連サイトに関わる内容に使用
pne-xhtmlcss	XHTML+CSS	OpenPNEのXHTML＋CSS化に関わる内容に使用
その他	-	上記のコンポーネントに該当しない内容に使用

プロジェクトチケット作成ガイドライン

この図のように

• type = projectとする
• summary の先頭に【プロジェクト名】と入れる

上記2つをプロジェクト用のチケット作成時のガイドラインとする。

また同一プロジェクト内の作業（タスク）については、

• type = task or enhancement
• summary の先頭に【プロジェクト名】と入れる

とする。

プロジェクトチケットの表示

個別のWikiページにプロジェクトチケットを表示する場合には

== プロジェクトチケット ==
[/newticket?summary=%E3%80%90%E7%8E%84%E7%AE%B1PNE%E3%80%91&owner=junchiba 簡単チケット作成(summary=【玄箱PNE】&owner=junchiba)]

=== @in-BOX ===
[[TicketQuery(summary~=【玄箱PNE】&status=new&resolution=|&priority!=trivial)]]

=== @次の行動 ===
[[TicketQuery(summary~=【玄箱PNE】&status=assigned&resolution=|&priority!=trivial&type!=project)]]

=== @プロジェクト ===
[[TicketQuery(summary~=【玄箱PNE】&status=assigned&resolution=|&priority!=trivial&type=project)]]

=== @いつかどこかで ===
[[TicketQuery(summary~=【玄箱PNE】&resolution=|&priority=trivial)]]

[[WikiInclude(DIRECTORYNAVI)]]

上記の用にする。summary~=【玄箱PNE】とすることで、プロジェクトチケットを取得できる。

チケット編集ガイドライン

クローズ

チケットをクローズする場合は、必ず自分にreassignをかけてから行うこと。
クローズの種類は以下の基準に合わせて選択する。

【fixed】

既に対応が完了しているチケットに使用。この場合のみ、自分ではなくチケットのタスクを行ったユーザにassignをかける

【invalid】

無効のチケット（誤って作成したチケットなど）に使用

【duplicate】

他のチケットと内容が重複したチケットに使用。この場合、コメントに重複したチケットのIDを記載すること

【wontfix】

対応しないチケットに使用。通常は使用しない

【worksforme】

報告されたバグを再現できなかった場合に使用

収集ガイドライン

定期的にOpenPNE公式SNS内の書き込みを確認してバグ・要望を収集する。
収集の流れはpne-member参照。

バグ収集

• バグ収集は日記、トピック、トピックコメントを確認する
• 不具合報告の書き込みを発見したばあい、再現待ちのdefectチケットを作成する
• チケットのフォームは基準に合わせるが、descriptionは報告元のURLと内容のみにする
• チケットを作成したら、報告元の記事に必ずチケットのURLをコメントする

要望収集

• 要望収集は日記のタイトルに【要望】と入っている記事のみ確認する
• 要望報告の書き込みを発見したばあい、enhancementチケットを作成する
• チケットのフォームは基準に合わせるが、descriptionは報告元のURLと内容のみにする
• チケットを作成したら、報告元の記事に必ずチケットのURLをコメントする

バグ修正ガイドライン

修正バージョン

ticketのversionに入っている全てのバージョンを修正すること

コミット先

要望盛り込みガイドライン

pne-guidelines-note

動作テストガイドライン

動作テストはリリース前にenhancement・defectのチケットのみ行う。

テスト表作成

テスト表作成は以下の場所を利用

動作テスト用スプレッドシート作成先	​docs.openpne.jp
スプレッドシートフォーマット	​20071128_動作テストフォーマット

フォーマットの項目は以下のように使用

チケット一覧
type	チケットのtypeを記入
Id～Component	reportのチケット一覧と同じ内容
テスト項目作成	テスト項目を作成したかどうか（作成したら日付と○）
テスト	テストと項目を全てチェックしたかどうか （テストが完了したら日付と○を記入。×項目が残っている場合は×にする ）

enhancement / defect
ID	1からの連番
ticket	チケットのURL
Summary	チケットのSummary
module	テストする画面のモジュールを（admin,pc,ktai,biz,ktai_biz）
type	テストする画面のタイプ（page,do）
action	テストする画面のアクション名
動作	テストの動作
入力値・設定値	フォームの入力値、設定値などの条件
結果	テスト動作から期待される結果
テスト結果	期待される結果が得えられたかどうか
テスト備考	テスト結果の補足

動作テスト

動作テストはreport内で「テスト待ち」になっているticketを優先的に行う。テスト結果の種類は以下のとおり。

種類	例	基準	備考
日付+○	2007/12/28○	期待される結果が得られた状態。正しく動作している	-
日付+△	2007/12/28△	不具合ではないが例外の結果が得られた場合	テスト備考に詳細を記入。
日付+×	2007/12/28×	不具合が発生している状態。バグ発見時、またはdefectが改善されてない	テスト備考に詳細を記入。新たにチケットを作成した場合はチケットのURLも記入

パッチ受け入れガイドライン

OpenPNEプロジェクトでは、OpenPNEを進化させるためのソースコードの提供を歓迎します。 UIに関わるパッチかそうでないかによって受け入れ手順が変わります。

UI変更を伴わない不具合修正・機能追加

UIに影響の無い不具合修正や機能追加は、パッチを送付頂ければOpenPNEの開発版ソースコードにマージします。

UI変更を伴う機能追加

OpenPNEのUIに変更を与えるような機能追加の場合は、UIの整合性を統一する作業が必要になります。 UI検証チームによって整合性を評価し、仕様の追加変更作業を行います。

WikiInclude(DIRECTORYNAVI)?