Skip to content

Issueの運用方法

SORCERIAN Next edited this page Nov 15, 2018 · 20 revisions

Issueは数が多くなると、更新が埋もれやすくなります。適宜、ソート順を「Recently Update」に変更するなどしてご確認ください。

Title

  • 極力短く、内容を類推できる程度には具体的に
  • 新機能、バグなどの区分はLabelで行うので、【バグ報告】などの文言は付けない

Label

以下のものを利用する(ラベルは状況に応じて複数付与します)。 一覧でのフィルターで利用するので、必ず適切なものを付与してください。 不足のものがあれば、リクエストしてください。

報告/提案時に付与するもの

新規Issue立ち上げ時には、以下ラベルのいずれかひとつを選択して必ず付与してください。

  • bug:バグ報告
  • enhancement:新機能/改善提案
  • question:機能に対する質問

また、特殊な案件については、合わせて以下のLabelも付与します。

  • High:優先度/緊急度の高いもの
  • Compatibility:現在、もしくは将来に互換性を損なう可能性のある変更
  • Request:改定に伴い、なにかしら作業ご協力のお願いを伴う(詳細は下記「既存Issueへのコメント」を参照)

従来Excelでの「優先度低」「同・中」はあまり意味がなかったので、廃止しています。

Compatibilityは、基本的には最低限、スタッフ全員の承認のもとで対応を進めるものとします。ただし、OKのみの返信を形式的に待つ or 回収のための手間をかけるのは辛いので、一定以上の時間が経過したもので、交々のやりとりから反対はないと判断したものはExpired soon(下記)を付与し、一定時間後、ステータスを進める(Close or Confirmed)ものとします。

その後の進行に応じて付与するもの

以下のものはあとから状況に応じて、管理者が付与します(ConfirmedはIssue立ち上げから1~2Wほどを目安に、問題なしと判断したものから立てていきます)。

  • Confirmed:議論終了(ただし、実装時に仕様を微修正する可能性はあります)。実装待ち
  • Testing:実装/修正完了。次回のテスト期間に確認をお願いしたい対象(→テスト終了後、クローズします)
  • Expired soon:Compatibility案件にのみ付与。時間が一定以上経過したため、管理者判断で、1W程度を目途にClose、またはConfirmed(ご意見ある場合にはお早めに!)
  • wontfix:バグに問題がなかった、機能追加/修正を見送る(→クローズします)

また、最終的に対応が終了したものはクローズフラグを立てるので、Labelとしては設けません。

クローズについて

  • enhancement、bugについては管理人が状況に応じて、クローズします(基本はテスト終了後か、wontfixのタイミングで)。
    • bugについては、その性質上、報告者さまに修正時点でできるだけお早めにテスト戴ければ。ただし、他の方にも内容周知と他への影響の確認も戴きたいという意味も含めて、その場ではCloseとはせず、Monthly機能テストの終了時にまとめてCloseします。
  • questionについては、解決したところで、質問者の方がクローズをお願いします。
  • ただし、外部投稿者による質問は、外部投稿者窓口さんの方でクローズをお願いします。

※closeはページ末尾のボタンから可能です。 https://1drv.ms/u/s!AoLnW1UCwjdIxwkF1vRHjCDFC5X5

Milestones

  • 複数のIssueを管理するための機能です。enhancement、bug対象のIssueに対して、Monthly Updateを束ねるために利用します。テスト対象を識別するためにご利用ください。
  • Milestonesの設定はConfirmedに昇格する際に管理人が付与します。
  • たとえば、December Updateは以下のようにまとめています(https://github.com/snext1220/stext/milestone/2
  • 期限(due)はテストの期限を示しています。
  • その他、Monthly Updateとしての備考などはMileStonesとしてメモしたいと思います。

本文

全般

  • ひとつのIssueに複数の問題/提案を含めない(あくまでExcel表での一行のイメージ)。
  • 議論の中で別提案/問題が出てきた場合も速やかにIssueを分離する
  • 別運用の掲示板と区別の為、挨拶などは基本省略

新機能/改善提案

可能な範囲で、具体的なご要望をお願いします。 たとえばSGMLであれば具体的に「こんな書き方をしたい」(下記)、画面であれば、ざっくりとしたイメージを添付いただくと、話も速く、後続の作業もスムーズとなります。

<scene id="100" stars="4,4,4,4,4,4,4">

既存Issueへのコメント

  • 積極的な議論の場にしていければとは思いますが、すべてのIssueへのお返事は不要です。ただし、情報共有負荷を減らすため、一読は戴けますと(Recently updatedソートで最新のUpdateを確認できます)。
  • Compatibilityについては、お手数ですが簡単でも結構なので、なんらかのコメントをお願いします。
  • コメントの際は「賛成/反対」「賛成の場合は優先度(ぜひ欲しい、あっても良いなど)」「反対の場合もその程度(あると困る、なくても良い)」を明記ください。
  • ご意見なかったIssueをConfirmed昇格するかどうかは、管理人判断と致します。思いつきで挙げているIssueも多いので、相応の確率でwontfix(破棄)とする可能性はありますのでご了承ください(必要なIssueについては、最低コメント戴いた方がwontfix事故は防げるかと)
  • Issueに伴い、データ生成や調整などの付随作業が発生する場合があります([Request]ラベルを伴うもの)。適宜ご協力を募らせて戴きますので、恐縮ですが、可能な方ご協力お願いします。一定、優先順位のフィルターにもなると思うので、ご協力得られたIssueから作業してまいります。

バグ報告

シナリオ開発時の問題は、実際に記述したSGML(発生sceneも)と発生したエラーをお教えください。 以下、基本テンプレート。


シナリオ名

  • 対象のシナリオ名をお願いします。

問題を再現できるSGMLコードの例

  • 既にUpされているコードであれば、具体的なscene、enemyなどのidを併記ください。
  • テストコードの場合は画像ではなく、テキストでの抜粋をお願いします(コピペの再確認のため)
  • GBATの場合も同様です。

発生しているエラー

  • コンソールにエラーが出ている場合はキャプチャなどお願いします。
  • その他、不具合のわかるキャプチャなどがあれば合わせて。

その他、状況報告については、以下でまとめています。 https://sorcerian.hateblo.jp/entries/2018/06/18

特にログは重要なので、エラーが出ている場合は添付願います。 キャプチャは本文にドラッグ&ドロップで埋め込み可能です。