There is often some context given in PR descriptions that is missing from commits, and it may be worthwhile to retain that information in our history in git. This PR adds that information to the merge commit when created through github-merge.py.
We should also encourage people to provide as much information as possible in the PR commits themselves, but I believe that is an orthogonal issue. Individual commits don’t need to have a description of the overall goal of a PR.
ACK
On Mon, Jul 10, 2017 at 9:49 PM, Pieter Wuille notifications@github.com wrote:
There is often some context given in PR descriptions that is missing from commits, and it may be worthwhile to retain that information in our history in git. This PR adds that information to the merge commit when created through github-merge.py.
We should also encourage people to provide as much information as possible in the PR commits themselves, but I believe that is an orthogonal issue. Individual commits don’t need to have a description of the overall goal of a PR.
You can view, comment on, or merge this pull request online at:
#10786 Commit Summary
- Add PR description to merge commit in github-merge.py
File Changes
- M contrib/devtools/github-merge.py https://github.com/bitcoin/bitcoin/pull/10786/files#diff-0 (2)
Patch Links:
— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/bitcoin/bitcoin/pull/10786, or mute the thread https://github.com/notifications/unsubscribe-auth/AGGmv2dCxNyQQJAXY55qxT8K8F0DFQXRks5sMoBSgaJpZM4OTU0D .
174@@ -175,6 +175,7 @@ def main():
175 if info is None:
176 exit(1)
177 title = info['title'].strip()
178+ body = ' ' + info['body'].replace('\n', '\n ')
body = info['body'].strip() like the above. And the body indentation should be below.
ACK 475c08c.
For the record, after this, the PR description must be part of the review process. Don’t forget that there can be typos, markdown, links for temporary resources, etc that will be written in stone. Maybe for future improvement is to print the body and prompt for confirmation.
<img>code).