プルリクエストで意識していること
概要
相生葵の Advent Calendar 2020 10日目の記事です。
自分がプルリクエストで意識していることを書きます。
目次
- プルリクエストの目的
- コメントを書くとき意識していること
- コメントをもらうとき意識していること
1. プルリクエストの目的
- 自分の技術向上のため
コメントする側でも、コメントされる側でもこの目的を意識しています。
2. コメントを書くとき意識していること
- 柔軟な姿勢
- 理由をつける
- 理由には記事のリンクもつける
- 具体的なコードも記載する
1. 柔軟な姿勢
絶対にこっちの方がいいと思ってコメントしていても、プロジェクトで決まっているコーディングルール以外は「直してください」という姿勢では書かないようにしています。
理由はもし今の方法にしていることに明確な理由があるにも関わらず、押しが強い姿勢でいってしまった場合、コメントを受けた側がコメントを書いた側の意見を圧によってうのみにしてしまう可能性があるからです。
もし、自分の書き方ではなく相手の書き方の方がよかったのにこうなってしまった場合、一つ技術向上の機会を逃すことになります。
2. 理由をつける
以下の2点を目的にしています。
- 根拠が自分の中にあることを確認すること、その理由が人に説明できるくらい自分の中で明確であること
- 相手に理解してもらいやすくすること
プルリクエストに根拠を書いてみて、あやふやだと感じたら、調べたり実際にコードを書いてみて明確にしていきます。
3. 理由には記事のリンクもつける
検証記事や公式の説明などがあればリンクをつけるようにしています。
これは、理由の補強です。
4. 具体的なコードも記載する
文章で書いていても、具体的にコメントを書いた側がどのように考えているのかが分からないことがあると思っています。
そのため、具体的なコードも必要そうであればつけるようにしています。
書き方が分からなければ、調べる必要があるので自分も書けるようになります。
3. コメントをもらうとき
- コメントには必ず何らかのアクションを返す
- 提案は受け入れるという姿勢でいる
- 提案されたものを受け入れるか判断に迷ったときは他のメンバーにも聞いてみる
1. コメントには必ず何らかのアクションを返す
コメントをスルーすると、次回から自分が書いたコードに違和感を感じてもコメントしてもらえない可能性があります。
そのため、必ずいただいたコメントにはアクションを返すようにしています。
2. 提案は受け入れるという姿勢でいる
自分の書き方が絶対という考え方は持たず、改善のため提案は受け入れるという姿勢でいます。
3. 提案されたものを受け入れるか判断に迷ったときは他のメンバーにも聞いてみる
自分の書いたコードにも理由があり、相手の提案にも理由がありどちらがいいのか迷うことがあります。
このときは、提案者以外のメンバーにもどちらの書き方がいいのかを聞いてみたりします。