読者です 読者をやめる 読者になる 読者になる

ぱと隊長日誌

ブログ運用もエンジニアとしての生き方も模索中

Facebook APIのバグレポートの書き方

はじめに

 Facebook API(と総称していますが、Graph APIやFQL等)を利用していると、おかしな挙動に悩まされることがあります。時には明らかにバグとしか思えないことも。そんな時はバグレポートを送ってみましょう。

英語の壁

 バグレポートは英語でやり取りします。
 英語は苦手ですか?でも大丈夫。英語は中1でつまずいたままの自分でも何とかなっています。コツは以下の通り。
・説明するより実例を挙げる。
・本質的な問題だけ伝える。余計な情報は伝えない。
・センテンスは短く。
 特に実例は大事です。英語は分からなくても、コードで語ればいいのです。

バグレポート作成の流れ

同様のバグレポートがアップされていないかを確認する

 既にレポート済みの事象を再度レポートしても、重複とみなされてしまうだけです。それに、もしかしたら既に修正作業中かもしれません。バグレポート作成は一度既存のレポートを確認してからにしましょう。
 他のバグレポートは以下から確認できます。
バグ- Facebook Developers
 また、同様のバグレポートがあった場合、そのバグレポートページの"Does this repro describe your issue? Yes"の"Yes"リンクから自分のアプリに関する情報を報告できます。積極的に報告しましょう。

バグレポートページを開く

 以下のリンクからどうぞ。
Home - Facebook開発者
 バグ一覧ページで検索キーワードに任意の文字を入力すると、サジェスチョン結果に"Create a new bug report"が現れるので、そこをクリックしても開けます。
バグ- Facebook Developers

バグレポートの記入

 バグレポートページのフォーマットに沿って記入します。ポイントを以下に挙げます。

1)TitleとDescriptionを具体的に書く

 この2項目はバグ一覧ページで表示されます。つまり、他の開発者も見れるということ。他の開発者の目に留まれば、同様の報告や回避策が集まるかもしれません。

2)Steps to Reproduceを詳細に書く

 再現できるだけの情報がないと差し戻されます。入力欄に表示されている例を参考に記入してください。

3)Related IDs/Access Tokenを記入してよいところ・してはいけないところ

 "Related IDs"及び"Access Tokens"という項目にはID(User ID等)やAccess Tokenを記入しても構いません。この内容はFacebookの担当者のみ閲覧できます。他のユーザーには見えません。
 また、問題を再現させるためにFacebook側から提示を求められることもあります。迅速な解決のためにも最初から提示しておくことをお勧めします。
 ただし、"Steps to Reproduce"には書かないでください。この欄は他のユーザーにも見えているからです。再現手順のコード中にアクセストークンが含まれることを記載したい場合は[access_token]のように記載しておけばよいでしょう。

最後に

 大切なのはバグレポートの提出を恐れないことです。
 誠意をもって向き合う限り、誠意をもって対応してくれます。英語が苦手だとか、とんちんかんなこと言ってたらどうしようとか不安に思う前に、まずはレポートしてみる。その勇気こそが一番大切なことです。