From ff57c2e6923cc3698ccd2c44579037487b06ca8c Mon Sep 17 00:00:00 2001 From: "brian m. carlson" Date: Thu, 30 May 2019 14:41:52 +0000 Subject: [PATCH] CONTRIBUTING: encourage a rationale in the pull request Sometimes we get pull requests that have no description or rationale. This makes it hard for maintainers to evaluate why the pull request is needed and what problems it is intended to solve. Encourage users to provide some explanation in the pull request and hinting that they may use part (or all) of their good commit message to accomplish this goal. --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e05638f..671eccd2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,6 +71,8 @@ Here are a few things you can do that will increase the likelihood of your pull would like to make that are not dependent upon each other, consider submitting them as separate pull requests. * Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). +* Explain the rationale for your change in the pull request. You can often use + part of a good commit message as a starting point. ## Building