github-issues

GitHub Issue と PR のコメントガイドライン

避けるべきアンチパターン

• 構成しすぎた返信：簡単な返信に見出し、番号付きセクション、箇条書きを使わないでください。通常は会話調の段落のほうが適切です。
• 定型的な書き出し：すべてのコメントを同じ書き出しにしないでください。会話の雰囲気に合わせましょう。
• 明白なことの言い直し：質問を受けたら、そのまま答えてください。相手の発言を要約する必要はありません。
• 企業広報のような告知：「喜んでお知らせします……」ではなく、何が変わったかを伝えてください。
• 修正完了後の過剰な説明：問題が修正済みで報告者に対応事項がない場合、リリースプロセスの詳細を読ませないでください。

トーンについてはwriting-voiceに従ってください。

メンテナーへの敬意を忘れない

Issue の報告者もメンテナーも忙しいものと考えてください。敬意を示すコメントは、通常、状況を明確に伝えて話を締めくくる、できるだけ短いものです。

コメントを簡潔にするルール

下書きを始める前に、読者が次に知るべきこと、またはすべきことは何かを考えてください。それだけを含めます。

ほとんどのコメントは、次の構成にします。

1. 相手への気遣いを込めた謝意。
2. 現在の状況、または直接の回答。
3. 次の対応。必要な場合に限ります。
4. 温かみのある締めくくり。

温かみは伝わるように、ただし控えめにします。冒頭または締めの文の末尾に感嘆符を1つ付けるのがおすすめです。締めの文に付けるのが通常は最適です。「見つけてくださり、改めてありがとうございます！」

読者が回答の確認や次の対応に必要としない限り、内部プロセスの詳細は加えないでください。

修正済みの問題

修正済みの問題には、次の順序で対応します。

1. 報告してくれたことに感謝します。
2. 現在の状況を直接伝えます。
3. 確認に役立つ場合に限り、具体的なバージョン、リリース、PR、またはコミットに言及します。
4. 通常は感嘆符を1つ添えて、簡潔に感謝を伝えて締めくくります。

返信に役立つ場合を除き、報告者が正しかったとわざわざ認める必要はありません。通常は感謝を伝え、現在の状況を述べれば十分です。問題が内部の仕組みに関するもの、または修正の確認に必要な場合を除き、内部の仕組みについて説明しないでください。

例：

Hey @username, thank you for flagging this.

This has been fixed, and current releases now include npm provenance attestations.

Thanks again for catching it!

書き出しのパターン

スレッドへの最初の返信では、ユーザーの GitHub ハンドルを使って個人的に挨拶します（やり取りが続いている場合は省略できます）。

• 「こんにちは、@username さん。Issue をありがとうございます」
• 「皆さん、こんにちは。お知らせありがとうございます！」
• 「皆さん、こんにちは。Issue をありがとうございます！」

基本要素

1. 謝意

• Issue や貢献に感謝することから始めます。
• 問題に共感を示します：「それは大変でしたね！」「ショートカットが失われてしまったとのこと、申し訳ありません！」
• 返信が遅れた場合はお詫びします：「ご返信が遅くなり、申し訳ありません」

2. 良い知らせの伝え方

機能や修正を知らせるときは、次のようにします。

• 「朗報です！」または「良いお知らせです！」
• お祝いの絵文字は控えめに使います。
• 貢献者に感謝します：「アイデアをありがとうございます」または「アイデアをくださった@user1さんと@user2さんにも感謝します」

3. デバッグの申し出

複雑な問題には、直接サポートを申し出ます。

• 「お時間があれば、通話で一緒にデバッグできればと思います」
• 「近日中に通話して、一緒にデバッグしましょう」
• 通話を提案する場合は、cal.com のリンクを含めます：「https://cal.com/epicenter/whispering」
• 確認できない具体的な対応可能日時（「早ければ明日対応できます」など）を約束しないでください。

4. Discord の案内

報告者がプロジェクトに強い関心を持っているようであれば、ときどき Discord に招待します。

• 「追伸：最近 Discord グループも作りました。ぜひ参加してください！新機能について、私に直接メッセージを送っていただけます。」
• リンクを含めます：「https://go.epicenter.so/discord」

5. 追加の質問

問題をよりよく理解するため、明確化の質問をします。不足している情報、つまり正確なバージョン、プラットフォーム、最小限の再現手順などを尋ねます。

• 「確認ですが、最新のインストーラーでもこの問題が発生することを確認していただけますか？」
• 「ご利用の OS とバージョンを教えていただけますか？」

6. 締めくくり

感謝の言葉で締めくくります。

• 「ありがとうございます！」
• 「改めてありがとうございます！」
• 「ご協力ありがとうございます。確認します！」
• 「どういたしまして！」（感謝された場合）

返信例

機能実装への回答

Hey @username, thank you for the issue, and good news! [The latest release](link) now includes the [feature]! Thank you for the inspiration.

[Brief description of how it works]

PS: I've also recently created a Discord group, and I'd love for you to join! You can ping me directly for more features.

https://go.epicenter.so/discord

デバッグに関する回答

Hey @username, so sorry to hear this! I apologize for the delayed response; I was finalizing [the latest release](link).

To clarify, could you confirm that this issue persists even with the latest installer?

If you have time, I would love to hop on a call with you, and we can debug this together. You can book a meeting with me using my cal.com link right here:

https://cal.com/epicenter/whispering

Thank you!

簡潔な了承

Hey @username, sorry to hear [problem]! Did you ever get a fix?

PR での議論（やり取り）

Good catch! Updated to only clear the dev app cache in nuke mode.

The flow is now:
- `bun clean`: artifacts and node_modules
- `bun nuke`: above + Rust targets + dev cache

Let me know if you want a confirmation prompt before clearing.

文体に関する注意事項

• 具体的なユーザーに言及して謝意を示し、関連する issue、リリース、コミットにリンクします
• PR のコメントは簡潔でかまいません。継続中の議論では、完全な挨拶や結びの言葉は必要ありません
• 相手の熱量に合わせます。短い質問には短く答え、詳細な報告には詳しく回答します