不具合報告に求める基準

不具合報告は、次の条件を満たしている必要があります。良き不具合報告は、コミュニティにとって良き資産と考えます。どなた様からの起票を歓迎いたします。

1. 問題解決を目的としていること
2. 次の要素「発生事象」「期待挙動」「再現手順」が簡潔に記載されていること
3. 第三者であるメンテナでも理解できるように記載されていること

これらの条件を満たしていない報告は私たちの問題ではなく貴方の問題です。ご自身で対応をお願いします。

対応方針

著者からの対応は、次の表の通りに対応します。

分類	内容
ユーザー	上記の情報が過不足なく提供されることを要求します。基準に満たない場合はクローズします。
貢献者	著者からの追加の質問や、こちらのデバッグなどを実施して問題解決できるように努めます。

良い不具合報告をするための技術

不具合報告の事例

いくつかの不具合報告をみながら解説をしていきます。

📝 Missing required module 'SwiftPMSupport'

不具合報告に求める「再現手順」がないため解決は難しいと思って様子見していたIssueです。最終的に再現手段の提示がやはりないためクローズしました。問題解決のためのコミニケーションが取れずに残念です。

• 著書は、再現提示を求めているが有効な回答を得られていない
• わたしも同様の問題を抱えていますと擁護する人がいるが問題解決の情報が増えてなくノイジー
• 回避方法を提示する人もいるが、そもそも発生原因が分からないのであっているか分からないので採用できない
• 普段議論に参加していない人がたくさんでてくると不信感がつのります。同僚同士なら会社チャットでやって愚痴って欲しいです

添削結果

-	Does	Don't
発生事象	ビルドエラーの発生	ビルドエラーの発生
期待挙動	コンパイルでき。アプリが起動できること。	アプリが普通に起動する。
発生手順	1. Xcode16.Xを起動する 2. Xcodeの新規プロジェクト作成 3. Projectに対してPackage Depenciesを追加 4. ビルドを実行する	Package.swiftのコードの提示

• もっとも、上記手順では試しており。いまだに、どうやって再現できるかわかっていません。

📝Crashing after few seconds

第三者に分かりやすいという観点に欠けるためクローズしました。その後の同僚と見受けられ方のコメントも「事象の報告」であり。著者からの「再現方法」質問の回答になっていなく不満です。

• ストーリーミングとは、視聴、配信どちらの意味か判断つかない。おそらく視聴と推測はしました。
• RTMP、SRTなのか判断つかない。
• 視聴系の不具合を見る場合は、配信側の情報。主に映像コーデック。音声コーデックが必要など付加情報がない。
• 自身で書いたコードなのか、テストコードなのか判断つかず。
• ログが整形されておらず見づらくて辛いです。

添削結果

-	Does	Don't
発生事象	SRT経由でライブを視聴するとクラッシュが発生します	ストリーミングするとクラッシュする
期待挙動	クラッシュせずライブを視聴が継続できること	クラッシュしないこと
発生手順	前提として サーバーはXXXを利用 配信側は、OBSを利用しており。映像はH264。音声はOpusを利用 手順として 1. サンプルアプリ(iOS)を起動 2. 視聴タブへ遷移 3. 視聴ボタンをタップ	数秒ストリーミングすると発生する

容認できない行動の事例

行動規範に従って厳密に対応していきます。

📝 timestamp is error,when has B frame

📝 timestamp is not increase!

📝 frame type is error

「発生事象」「期待挙動」「再現手順」が不足しており。また、第三者に理解できるように書くという意識が感じられずクローズしました。次の行為は、許容できずブロックしています。

• 同一の内容を連投するスパム行為を行なっている
• 他人を罵倒する発言する