会社の成長に伴い、人とプロジェクトが変わります。 GitHubで提供したい文化の発展を継続するために、コミュニケーションで追求する目標を思い出すことが有用であることがわかりました。 プルリクエストを介してやり取りする際に自分自身が良くなるように、最近これらのガイドラインを導入しました。
プルリクエスト作成アプローチ
- このプルリクエストの目的を説明してください。 例：
これはスタブです...
これにより、表示が簡素化されます...
これにより、...への呼び出しが修正されます。
- この作業が行われた理由について簡単な情報を提供することを検討してください（適切なリンクを使用）。 誰もがストーリーに精通していると思い込まないでください。
- 会社の全員がこのプルリクエストを読むことができるので、コンテンツやトーンは、現在または将来、ディスカッションを行っている人とは異なる人に知らせることができます。
- どのようなフィードバックを受け取りたいか、具体的に説明してください。たとえば、邪魔にならない目、技術的アプローチの議論、デザインに対する批判、コピーレビューなどです。
- フィードバックが必要な場合は具体的に説明してください。 プルリクエストが進行中の場合は、報告してください。 ヘッダーの「[WIP]」プレフィックスは、ステータスを報告するためのシンプルでわかりやすい方法です。
- @会話に接続したい人に言及し、その理由を示します。 （「/このロジックを説明するCc @jesseplusplus」）
- @ディスカッションに参加したいチームに言及し、その理由を示します。 （「/ Cc github /セキュリティ、このアプローチに関する懸念？」）
フィードバックを残す
- 問題のコンテキストと、このプル要求が存在する理由を読んでください。
- 強く同意しない場合は、回答する前に数分間気を散らしてください。 話す前に考えてください。
- 断るのではなく、尋ねる。 （「試してみてどう思いますか...？」の代わりに「これをしないでください...」）
- コードを変更する必要があると思う理由を説明してください。 （ スタイルガイドによらない？個人的な好み？）
- コードを簡素化または改善する方法を提案します。
- 誰かが行った仕事を指すときは、「愚かな」などの軽rog的な言葉の使用を避けます。
- 謙虚に。 （「よくわかりません。試してみましょう...」）
- 双曲線の使用は避けてください。 （「絶対にやらない...」）
- グループの批判を通じて、専門的なスキル、一般的な知識、製品の品質の向上に努めます。
- オンラインコミュニケーションの否定的な意味合いを忘れないでください。 （コンテンツがニュートラルの場合、トーンは負に設定されていると想定します）。 ニュートラルではなく、よりポジティブな言語を使用できますか？
- 絵文字を使用して、トーンを明確にします。 「
よさそうだ 
「そして」よさそうだ。
フィードバックへの対応
- 感謝の表現から始めることを検討してください。 特にフィードバックが混在している場合。
- 明確化を求めてください。 （「わかりません、明確にできますか？」）
- 問題を解決するためにあなたが下した決定を明確にし、説明してください。
- すべてのコメントに答えてみてください。
- 関連するすべてのコミットまたはプルリクエストにリンクします。 （「素晴らしいソリューション！1682851で実装」）
- 誤解や議論が増えている場合は、テキストがコミュニケーションを継続する最良の方法であるかどうかを自問してください。 顔を合わせて（実質的に）話し合い、結果を公開してオフラインの議論を要約することを検討します（現在または将来理解しようとする人にとって便利です）。
これらのガイドラインは、Thoughtbot
コードレビューガイドに部分的に触発されたものです。
私たちのガイドラインは、私たちの働き方と発展したい文化に関連しています。 それらがあなたにも役立つことを願っています。
素敵なチャットを！
———
すべてのバグ修正と翻訳の改善は、経由で
送信することができます
プルリクエスト。 プルリクエストを行うときは、このガイドを使用することを忘れないでください;）