Guideline

crystal-jp/issues's guideline

Issuer の皆さんへ

どんな時に作るのか

こんなことでお困りの時は、お気軽に issue を作っていただければ、何かお力になれるかもしれません。

• Crystal 本体や Crystal 関連のライブラリに問題を見つけたけど、本家のリポジトリに報告すべきか悩むとき。(bugs ラベルを付ける)
• Crystal 本体や Crystal 関連のライブラリに要求したい機能があるけど、本家のリポジトリで話し合う前に意見を求めたいとき。(features ラベルを付ける)
• Crystal について何か分からないことがある、相談したいことがあるとき。(questions ラベルを付ける)
• crystal-jp の活動について話し合いたいとき。(crystal-jp ラベルを付ける)

『issue にするほどでもないような……』と思ったらお気軽に Slack へどうぞ。

お願いしたいこと

もし、余裕があれば closed issues を検索して、過去にあなたと似たことで悩んだ人が居ないか、探してみていただけると幸いです。

似たような事柄の issue を見つけたら、 close されている以上なんらかの解決を果たしているはずなので、その解決策などを試してみてください。もし、それで解決しなければ遠慮なく 新しい issue として 登録していただければ幸いです(この時、説明文に試してみた issue の URL を貼っておくと素敵です)。

環境や再現方法、議論を開始した理由など

バグ報告時の再現手順、環境などの情報や、議論を開始するに至った理由、考えたことなど、issue の説明文には出来る限り詳細な情報を付与すればするだけ喜ばれます。

思いついた事柄はすべて書き込んでしまいましょう。 issue の説明文が長いことは美徳です！

Bug Report Guide

主にこんな情報が必要とされています。出来る限り書いてください。

• crystal version で出力されるバージョン情報
• OS の情報
  • OS X なら : plutil -p /System/Library/CoreServices/SystemVersion.plist で JSON 形式で OS のバージョン情報を得ることが出来ます。
• 再現するための手順、もしくはコード

Contributor の皆さんへ

crystal-jp のチームメンバーや、 issue 解決のために協力頂ける場合は、以下のガイドを参考にしていただけると幸いです。

bugs ラベルな issue

close する際は、 close するに至った理由を併記の上、 close していただけると幸いです。

例えば

• Crystal 本家への英語の連絡をして、本家 issue になった
  • 本家 issue へのリンクと共に、 close してください
• 報告しようか悩んでるうちになおった
  • "v0.7.8 で修正済み" などの言葉や、できれば問題が解決されたコミットへのリンクなどがあると最高に素敵です
• バグじゃなかった
  • 正しい該当ラベルをつけた上で、『バグじゃないね』と笑ってください

features な issue

close する際は、 close するに至った理由を併記の上、 close していただけると幸いです。

例えば

• Crystal 本家への英語の連絡をして、本家 issue になった
  • 本家 issue へのリンクと共に、 close してください
• 提案しようか悩んでるうちに実装された
  • "v0.7.8 で実装済み" などの言葉や、できれば実装されたコミットへのリンクなどがあると最高に素敵です
• もうあった
  • 該当機能の使い方などがわかる参考 URL へのリンクや説明と共に、笑って close しましょう

ラベルのない issue

ラベルのない issue を見つけた時、お手すきなら issue に適切なラベルを付与していただけると幸いです。