Skip to content

バグ報告する際に欲しい情報(暫定版)

Shougo edited this page Sep 1, 2011 · 6 revisions

バグを報告してもらえる場合、次の情報があると良いです。ちなみに、neocomplcacheを対象にしていますが、他のプラグインでも同じです。

  • 以前のneocomplcacheでは動作していたかどうか

できれば、git-bisectなどを利用し、おかしくなったコミット番号まで調べてください

  • 特定のファイルタイプでおかしい場合、バグが再現する最小のソースファイル

例えば、「補完文脈を読まない」ではよく分からないし、テストもできません

  • 使用しているneocomplcacheの設定

これはできれば、あると便利という程度。ただし、特殊な設定をしている場合は明記してほしいところです。

  • 不具合はVimの設定に依存していないかどうか

できれば、vim -u NONE -U NONEあたりで起動して、動作が異なるかどうかのチェック。 neocomplcacheの設定部分だけ無効化してもよいです。

  • Vimのバージョン、使用しているVimの種類、OS等

できれば、複数の環境で試してもらえると、環境依存の問題を切り分けることができます。

  • プラグインの処理でエラーが出ている場合、そのエラーを全て教えてください。スクリーンショットでも良いです。

ちなみに、エラーメッセージを表示するには:messageコマンドを実行します。unite.vimを使うと、:Unite output:messageが使えます。 unite.vimの場合、候補を選択してすると該当する部分がバッファに貼り付けられるのでかなり便利です。

  • ダメなバグ報告例

「neocomplcacheが不安定」

不安定は何も言っていないことに等しいです。プラグインのバグについては、真面目に原因を調べて議論しましょう。

「neocomplcacheが動かない」

動かないだけでは、よく分かりません。おそらく、「もっと詳しい状況を教えてください」と返信が返ってくることになります。