[
https://issues.apache.org/jira/browse/DRILL-7478?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16994988#comment-16994988
]
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-565149077
Makes sense. Maybe provide the commit template that gives the gist of the
change. (The JIRA number is not sufficient, requires a check or JIRA just to
find out, say, that this was upgrading library X to a new version.)
I like the pattern you have used: to create a README file to explain things.
That becomes a permanent source of documentation. For other cases, a `.md` file
or `package-info.java` can serve the same purpose.
This leaves the PR note. It should include the same info as the commit
(though perhaps in another form.) We can offer two parts:
1. Outline of the topics that might be covered, if relevant. (Just omit the
bits that don't apply rather than filling in "Does not apply.") This is where
the (reformatted) commit message would go.
2. Checklist of common tasks. The author is free to remove those that don't
apply (such a "check license terms for any new libraries" if no libraries are
added.) Add those that do apply to this case.
----------------------------------------------------------------
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)
