プルリクエストを書くための正しいアプローチ
- このプルリクエストの目的を明確に定義します。 例:
… …
- この作業が行われた理由の簡単な説明(関連リンクを含む)を含めるとよいでしょう。 リクエストを読んでいる開発者がストーリー全体に精通していることを期待しないでください。
- この要求は、会社の従業員によって潜在的に読み取られる可能性があることに留意してください。 たぶん一年で。
- このリクエストに応じて、どのような反応を期待するかを明示してください。 リーダーからのマージ以外の何かが必要ですか? コードを見て、技術的な実装、設計に対する批判、テキストのレビューなどを評価してください。
- いつ応答を期待するかを明示的に示します。 リクエストが進行中の場合は、説明にプレフィックス「[WIP]」(作業中)を追加するのが一般的です。 これにより、読者は、完成した作品を見ていないことに気付きながら、早い段階でコメントを送ることができます。
- @リクエストのディスカッションで見たいものに言及してください。 そして、なぜかというと、これには特別な構文があります:
/cc @jesseplusplus for clarification on this logic
- @開発者だけでなく、チームについても言及できます。 同じことが、あなたが彼らと議論したい理由にも当てはまります:
/cc @github/security, any concerns with this approach?
他の誰かのプルリクエストへの反応
- このプルリクエストが発生したコンテキスト、関連タスク、ディスカッション、バックグラウンドを調べてみてください。 もちろん、これがすべてであれば。
- プルリクエストが原因で本能的な否定的な反応が発生する場合は、数分のタイムアウトを取り、すべてを慎重に再検討してください。 おそらく、著者はバカではなく、通信エラーが発生しただけです。 これは驚くほど一般的です。
- 提供するのではなく、尋ねる。 コミュニケーションを促進するためのシンプルで効果的な心理的トリック。 「…を使うことについてどう思いますか?」というフレーズは、「それをしないで
自分を殺す」よりもはるかに少ない競合を引き起こします。 - コードを変更する必要がある理由を説明してください( コーディングスタイルとは反対ですか?個人的な好み?)
- コードを簡素化および改善する方法を提案します。 これは、単に「すべてが悪い」と批判するよりもはるかによく知覚されます。
- 批判といえば。 他の人の仕事に関連して「愚かな」ような評点を避けるようにしてください。 コミュニケーションを確立するのに非常に役立ちます。
- もっと控えめにする必要があります。 ビジネスには「わからないが、やってみよう...」が必要です。「これを20年間やっています。」よりもはるかに優れた共通言語を見つけるのに役立ちます。 これを行い、理由を聞かないでください。」
- 誇張を避けます(「これを絶対にしないでください」)。 それらはすべて非常に異なって認識します。
- あなたの目標として、プロとしての資質、会社の知識、製品の品質の向上を設定してください。 うんざりしていませんか? はい、しかし、彼らは通常、批判で楽しもうとしています。
- オンライン通信のマイナスのバイアスを考慮してください(中立的なコンテンツについては、常にマイナスのトーンを想定しています)。 テキストにスマイリーを配置しないために、「ポジティブ」言語を使用できます。
- 「ポジティブな」言語を使用することが困難な場合(長年にわたってジャーナリストがこれを理由を学んでいる)、絵文字が助けになります。 比較: ":きらめき::きらめき:見栄え:+1 ::きらめき::きらめき:"と "見栄えが良い"。
プルリクエストに対する他の人の反応
- 可能であれば、特にリクエストへの応答が矛盾している場合は、ありがとうのメモから始めてください。
- 不明な点がある場合は、明確な質問をすることをnotしないでください(「わかりません、わかりますか?」)。 これは、他の開発者が念頭に置いていたものに「追いつく」よりもはるかに効果的です。
- すべての明確な情報を自分で提供し、コード内の特定の決定の理由について話してみてください。
- すべてのコメントに返信するようにしてください。
- リンクのコミットとその他のプルリクエスト(「Good call!Done in 1682851」)
- 議論が議論に発展し始めている場合は、立ち止まって、書面で対話を続けることが理にかなっているかどうか自問してください。 練習では、ほとんどの場合、Skypeまたは別のボイスチャットですべてを議論し、その後簡単な絞り込みと議論の結果のみをテキストとして追加する方がはるかに便利であることを示しています。
このガイドに触発されて、記事を書きました。 私たちが仕事で使用している技術と、私たちが順守しようとしている文化について説明しました。 それらの中で何か役立つものを見つけてください。
成功したコミュニケーション!