バグ報告をするにあたって注意しておきたい事

CWXEditorのバグ・不具合が報告されるのは、開発者にとって大変ありがたい事ですが、内容によっては調べて直そうにも為す術が無い事があります。それは大抵、情報不足のせいです。

バグ報告を行う時は、「出せる情報を出せるだけ出す」事をおすすめします。

何をしたら何が起きたか

どのような操作をして、どのようなトラブルが起きたかの情報は絶対に必要です。「起動したらエラーが出た」というような事であっても必ず書いてください。

その不具合を何度でも発生させる手順があると大変助かります。これを問題の「再現」といいます。

例:

シーンビューを開いてメニューカードを選択し、「Ctrl+R」を押すとエラーが出ます。

どのシナリオか

不具合が発生した時に編集していたシナリオの情報があった方がよいでしょう。できればIssueの「添付ファイル」として問題のシナリオ自体をつけてください。ただし、他人の作った素材が含まれているような場合は、著作権とライセンスに注意してください。

シナリオを編集して、不具合と関係無い部分を削除したバージョンを作るのはよい事です。削除しても不具合が「再現」できるのであれば、その部分は不具合と関係無いという事です。関係無い部分が少なければ少ないほど、調査は簡単になります。

問題の不具合を発生させる事ができる最小限のシナリオを新しく作り起こす事ができれば、それがベストです。

CWXEditorのバージョン

CWXEditorを起動し、「ヘルプ」メニューから「バージョン情報」を開きます。枠で囲まれた部分はコピー&ペーストが可能なので、報告に含めるとよいでしょう。

例:

Build: 2017-12-29 02:24:58 Debug / Console (32-bit) Compiled by Digital Mars D 2077

発生した不具合は、実は過去にすでに報告され、修正されているものかもしれません。問題が「再現」可能なのであれば、最新版で試してみるとよいでしょう。

Downloads(ダウンロード)のページから、ファイル名がcwxeditor_fnine_から始まるファイルをダウンロードして、そこに含まれているテスト版で不具合の「再現」手順を試してみてください。

CWXEditorの設定

なんらかの設定変更がきっかけでバグが発生するようになっているかもしれません。

関係ありそうな設定を書き出してもよいですが、判断がつかない場合や、関係無さそうな設定が実は、という事もあるので、まとめて貼り出すのが早道です。過去の例を参考にしてください。

エラーログ

エラーが発生した時にダイアログボックスが表示された場合は、その中にある情報をコピー&ペーストして報告に含めます。

ヒント: 前後の行に「```」と書くと、改行もそのままにして貼り付ける事ができます。

例:

2015-07-14 15:34:13 [Build: 2015-07-14 15:33:19 Debug / Console (32-bit)]   cwx\utils.d:132 Stack Trace --------
cwx\editor\gui\dwt\mainwindow.d-mixin-4341, 4341
cwx\editor\gui\dwt\mainwindow.d-mixin-4344, 4344
cwx\editor\gui\dwt\cardlist.d-mixin-49, 49
cwx\editor\gui\dwt\cardlist.d-mixin-701, 701
cwx\editor\gui\dwt\cardlist.d-mixin-724, 724
cwx\editor\gui\dwt\cardlist.d-mixin-726, 726
cwx\editor\gui\dwt\cardlist.d-mixin-730, 730
cwx\editor\gui\dwt\cardlist.d-mixin-731, 731
cwx\editor\gui\dwt\cardlist.d-mixin-764, 764
2015-07-14 15:34:13 [Build: 2015-07-14 15:33:19 Debug / Console (32-bit)]   cwx\editor\gui\dwt\mainwindow.d:4498 4343 - 4350 - 4381 - 4384 - 4414 - 4456 - 4461 - 4466 - 4468 - 4470
2015-07-14 15:34:13 [Build: 2015-07-14 15:33:19 Debug / Console (32-bit)]   cwx\editor\gui\dwt\mainwindow.d:4499 [Access Violation] , 0: 0x0113C63C in bss_end
0x010CFB59 in bss_end
0x00ED3789 in bss_end
0x008CDE08 in cwx.editor.gui.dwt.dutils.NoIME.__Interface
0x011466C2 in bss_end
0x01146697 in bss_end
0x011465AF in bss_end
0x008CDECC in cwx.editor.gui.dwt.dutils.NoIME.__Interface
0x0117CD91 in bss_end
0x74E5337A in BaseThreadInitThunk
0x771A92E2 in RtlInitializeExceptionChain
0x771A92B5 in RtlInitializeExceptionChain

ダイアログボックスを消してしまった場合は、エクスプローラーのアドレスバーに%AppData%\cwxeditorと入力して決定すると、CWXEditorの関係ファイルが入っているフォルダが開くので、そこにあるcwxeditor_error.logを開けば、過去に発生したエラーログが全て記載されています。

以下のような部分を区切りとして、日時から今回発生した不具合のログを探すとよいでしょう。

2017-12-29 01:19:05 [Build: 2017-12-28 22:19:00 Debug (64-bit)] cwx\utils.d:134 Stack Trace --------

環境

「Windows 7では不具合が発生するのにWindows 10では発生しない」というような不具合が、過去に実際にありました。

使用しているOSのバージョンや、メインメモリをどれくらい積んでいるか、その他特殊な環境であればその情報を出す事をおすすめします。

例:

Windows 10 Pro (64ビット)、メインメモリ 16GB、編集していたシナリオはDropBox上にあるものです。