アカウント名:
パスワード:
プルリクエストは受け付ける側の負担を考慮して出すべきだと思います
たとえばコミットメッセージには(1)変更の概要(何を変更したか)(2)変更の理由(何故変更したのか)の両方を書くべきです
受け付ける側の立場からするとこの2つの情報が揃って初めて merge してみるかという気になります
タレコミのプルリクエストの例では(2)が欠けており変更の必要性が伝わってきませんこれでは無視されたり却下されても文句は言えないと思います
理由が他者に分からないならそれは書くべきだし、相手が分からなくて知りたそうな事は書いた方が良いのは一般にコメントと呼ばれるもので共通する配慮ではあると思う。
そのコメントはソースに書かれるべきか、コミットメッセージに書かれるべきか、プルリクエストのコメントに書かれるべきか。そのコメントは誰が見るもので、その彼は一体何を知らず、何を知りたいのか、難しいよね。
C的には一箇所に書いておき たどればいい、でしょうが、経験的に全部に書くべきと考えます。
まぁソースに書けばあとはコピペですが。
あと誰が見るものか、は考えても無駄です。自分(未来の)に伝わるようにだけ悩みましょう。自分すらわからないものが人に伝わるはずありません。
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
にわかな奴ほど語りたがる -- あるハッカー
悪いリクエストの典型例 (スコア:5, 興味深い)
プルリクエストは受け付ける側の負担を考慮して出すべきだと思います
たとえばコミットメッセージには
(1)変更の概要(何を変更したか)
(2)変更の理由(何故変更したのか)
の両方を書くべきです
受け付ける側の立場からすると
この2つの情報が揃って初めて merge してみるかという気になります
タレコミのプルリクエストの例では(2)が欠けており
変更の必要性が伝わってきません
これでは無視されたり却下されても文句は言えないと思います
Re:悪いリクエストの典型例 (スコア:0)
理由が他者に分からないならそれは書くべきだし、相手が分からなくて知りたそうな事は書いた方が良いのは一般にコメントと呼ばれるもので共通する配慮ではあると思う。
そのコメントはソースに書かれるべきか、コミットメッセージに書かれるべきか、プルリクエストのコメントに書かれるべきか。
そのコメントは誰が見るもので、その彼は一体何を知らず、何を知りたいのか、難しいよね。
Re: (スコア:0)
C的には一箇所に書いておき たどればいい、でしょうが、
経験的に全部に書くべきと考えます。
まぁソースに書けばあとはコピペですが。
あと誰が見るものか、は考えても無駄です。自分(未来の)に伝わるようにだけ
悩みましょう。
自分すらわからないものが人に伝わるはずありません。