もし FuelPHP のバグを見つけたら〜バグ報告の仕方
これは、FuelPHP に限りませんが、たまに Twitter などで「何々がバグってる〜」みたいなつぶやきをしてる人がいます。
もし、バグを見つけたら、本家にフィードバックすることをお薦めします。
なぜなら、本家でそのバグが修正されれば、次のリリースではそのバグはなくなるからです。
なお、バグかどうかはっきりしない場合は、
で相談した方がいいでしょう。
バグ報告の仕方
バグ報告の仕方には、次の 2つの方法があります。
- バグの内容だけを Issues に報告する
- バグを修正したコードを Pull Request する
まず、1. について説明します。
どこにバグ報告するか？
FuelPHP のソースコードは GitHub 上で複数のリポジトリに分かれて管理されています。
リポジトリの一覧は、
の「リポジトリ」を参照してください。
例えば、
Core であれば、
ドキュメントであれば、
になります。
パッケージはパッケージごとにリポジトリがわかれています。
該当するリポジトリの Issues にバグを報告することになります。
Core であれば、
ドキュメントであれば、
になります。
なお、GitHub のアカウントが必要になりますので、登録してない場合は、登録しましょう。
バグを報告する前に
バグを報告する前に、以下の点を確認しましょう。
- バグがすでに修正されていないか？
- バグがすでに報告されていないか？
バグを報告する
「New Issue」ボタンを押して、バグを報告します。
「Title」には、どんなバグかわかりやすいタイトルを英語で入力します。
その下に本文を英語で入力します。記載すべきは、
- バグの内容
- 再現の手順 (コード)
- 実際の結果
- 期待する結果
です。必要に応じて記載します。
再現できないバグは修正できませんので、再現の手順はできるだけあったほうがいいと思います。また、期待する結果を書いておけば、何故、それがバグだと考えるのかが相手にわかります。
以下のような見出しを付けて報告するといいかも知れません。
- What I did (自分がしたこと)
- What happened (何が起こったか)
- What I expected to happen (何が起こると期待したか)
- Steps to reproduce (再現の手順)
- Actual result (実際の結果)
- Expected result (期待する結果)
記入できたら「Submit new issue」ボタンを押して投稿します。
英語に自信がない場合
バグ報告は、バグの内容が伝わればいいので、英語については気にする必要はありません。
多くの場合、バグを再現するコード、実際の結果、期待する結果だけあれば、英語で一文も説明しなくても、バグの内容は伝わると思います。
それから、現代では 10億人の英語を話す人がいると考えられており、英語のネイティブスピーカーの少なくとも 3倍のノンネイティブがいるそうです。ネイティブとノンネイティブの割合を 1:3 と考えると 75% がノンネイティブです。つまり我々ノンネイティブはすでに圧倒的な多数派なのです。
要するに、我々の変かも知れない英語こそが、今や世界標準であり、ネイティブの正しい英語は世界ではむしろマイノリティなのです。
ということで、自信をもってバグ報告しましょう。
「もし FuelPHP のバグを見つけたら (2)」へつづく。
目次
