[
https://issues.apache.org/jira/browse/DRILL-7478?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16994275#comment-16994275
]
ASF GitHub Bot commented on DRILL-7478:
---------------------------------------
paul-rogers commented on issue #1921: DRILL-7478: Add Pull Request Template
URL: https://github.com/apache/drill/pull/1921#issuecomment-564868743
What is the intent here? Looks like this PR is trying to solve two problems:
1. Provide a standard template for PR messages,
2. Provide a checklist of things we want the contributer to do.
I wonder, should we think about the *commit* message; the one that will
travel with the code in Git?
For the commit message, a simple template would be helpful:
```
DRILL-XXXX: Summary
Description of change.
```
I have seen folks include only the bug number. (Of course, I'm not sure
anyone ever reads the commit messages...)
For the PR message, do we insist people keep our headings? Only our
headings? Should they replace the commit message with a differently worded
message? That is, do we want people to describe the change twice, in two
different ways?
Each time I've seen shops provide these templates, it ends up that either
the templates are off the mark, or they grow to be cumbersome. They are no
substitute for people just doing the right thing.
A good reviewer will look for tests (I do that first.) A `pom.xml` file
change should be carefully reviewed. What are we solving by adding a template?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Add Pull Request Template
> -------------------------
>
> Key: DRILL-7478
> URL: https://issues.apache.org/jira/browse/DRILL-7478
> Project: Apache Drill
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.16.0
> Reporter: Charles Givre
> Assignee: Charles Givre
> Priority: Minor
> Fix For: 1.17.0
>
>
> Adds a pull request template to github.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
