Hatena::ブログ(Diary)

A Day in Serenity @ kenjis

2012-02-03

もし FuelPHP のバグを見つけたら〜バグ報告の仕方

(2012/07/14) この一連の記事をまとめ加筆修正しアップデートした電子書籍をリリースしました。よろしければ、ご覧ください → 『FuelPHP に貢献する方法』(無料)


これは、FuelPHP に限りませんが、たまに Twitter などで「何々がバグってる〜」みたいなつぶやきをしてる人がいます。

もし、バグを見つけたら、本家にフィードバックすることをお薦めします。

なぜなら、本家でそのバグが修正されれば、次のリリースではそのバグはなくなるからです。

なお、バグかどうかはっきりしない場合は、

で相談した方がいいでしょう。

バグ報告の仕方

バグ報告の仕方には、次の 2つの方法があります。

  1. バグの内容だけを Issues に報告する
  2. バグを修正したコードを Pull Request する

まず、1. について説明します。

どこにバグ報告するか?

FuelPHP のソースコードは GitHub 上で複数のリポジトリに分かれて管理されています。

リポジトリの一覧は、

の「リポジトリ」を参照してください。

例えば、

Core であれば、

ドキュメントであれば、

になります。

パッケージはパッケージごとにリポジトリがわかれています。

該当するリポジトリの Issues にバグを報告することになります。

Core であれば、

ドキュメントであれば、

になります。

なお、GitHub のアカウントが必要になりますので、登録してない場合は、登録しましょう。

バグを報告する前に

バグを報告する前に、以下の点を確認しましょう。

  1. バグがすでに修正されていないか?
  2. バグがすでに報告されていないか?
バグがすでに修正されていないか?

自分が使っている FuelPHP が、リポジトリの開発ブランチ (現在は 1.1/develop) の最新のソースでない場合、最新のソースではすでにバグが修正済みの可能性があります。

開発中の最新のソースコードを取得してバグが再現されることを確認します。

バグがすでに報告されていないか?

あるいは、他の人がすでのバグ報告をしている可能性もあります。

GitHub のリポジトリの Issues のページで検索し、バグが報告されていないことを確認します。

バグを報告する

「New Issue」ボタンを押して、バグを報告します。

f:id:Kenji_s:20120202145059p:image

f:id:Kenji_s:20120202145125p:image

「Title」には、どんなバグかわかりやすいタイトルを英語で入力します。

その下に本文を英語で入力します。記載すべきは、

  1. バグの内容
  2. 再現の手順 (コード)
  3. 実際の結果
  4. 期待する結果

です。必要に応じて記載します。

再現できないバグは修正できませんので、再現の手順はできるだけあったほうがいいと思います。また、期待する結果を書いておけば、何故、それがバグだと考えるのかが相手にわかります。

以下のような見出しを付けて報告するといいかも知れません。

  1. What I did (自分がしたこと)
  2. What happened (何が起こったか)
  3. What I expected to happen (何が起こると期待したか)
  1. Steps to reproduce (再現の手順)
  2. Actual result (実際の結果)
  3. Expected result (期待する結果)

記入できたら「Submit new issue」ボタンを押して投稿します。

英語に自信がない場合

バグ報告は、バグの内容が伝わればいいので、英語については気にする必要はありません。

多くの場合、バグを再現するコード、実際の結果、期待する結果だけあれば、英語で一文も説明しなくても、バグの内容は伝わると思います。

それから、現代では 10億人の英語を話す人がいると考えられており、英語のネイティブスピーカーの少なくとも 3倍のノンネイティブがいるそうです。ネイティブとノンネイティブの割合を 1:3 と考えると 75% がノンネイティブです。つまり我々ノンネイティブはすでに圧倒的な多数派なのです。

要するに、我々の変かも知れない英語こそが、今や世界標準であり、ネイティブの正しい英語は世界ではむしろマイノリティなのです。

ということで、自信をもってバグ報告しましょう。

もし FuelPHP のバグを見つけたら (2)」へつづく。


目次

投稿したコメントは管理者が承認するまで公開されません。

スパム対策のためのダミーです。もし見えても何も入力しないでください
ゲスト


画像認証

Connection: close