[
https://issues.apache.org/jira/browse/MATH-1357?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15247659#comment-15247659
]
Rob Tompkins commented on MATH-1357:
------------------------------------
The {{.github}} directory is a standardized directory location for the
GitHub.com web application that provides the template functionality only for
pull requests opened there. If using that user interface is not the only
location for contributors to open pull requests, then I would agree
{{doc/development}} or the {{CONTRIBUTING.md}} should be our location. However,
if we are only letting contributors issue contributions via GitHub.com, then I
would make the best of their templating engine by putting
{{.github/PULL_REQUEST_TEMPLATE.md}} in place.
Regarding the checkbox, I'm agnostic on whether that's included, I've just seen
it on other open source projects (e.g. spring and spring-boot).
> Create Github Pull Request Template
> -----------------------------------
>
> Key: MATH-1357
> URL: https://issues.apache.org/jira/browse/MATH-1357
> Project: Commons Math
> Issue Type: New Feature
> Affects Versions: 3.6.1
> Reporter: Rob Tompkins
> Priority: Trivial
> Labels: github
> Fix For: 3.7
>
> Original Estimate: 1h
> Remaining Estimate: 1h
>
> I would like to have at the root of {{commons-math}} a directory named
> {{.github}} with a file named {{PULL_REQUEST_TEMPLATE.md}} that automatically
> populates the body of pull requests.
> For example, angular.js has the following
> https://raw.githubusercontent.com/angular/angular.js/master/.github/PULL_REQUEST_TEMPLATE.md
> Further we can include anything between the delimiters {{<!-- Some comment
> here -->}} will be seen by the github user opening the pull request, but not
> actually included in the comment. For example consider the one on the
> spring-boot project:
> https://raw.githubusercontent.com/spring-projects/spring-boot/master/.github/PULL_REQUEST_TEMPLATE.md
> I would propose we have the following:
> * A link to the CONTRIBUTING.md file in the project, which explains how to
> contribute. I would include this in the {{<!-- -->}} delimited section, as it
> is unnecessary to actually persist into the github pull request comment body.
> * A request to link to a Jira ticket number (which is relatively trivial to
> include).
> * A checkbox for the apache contributor agreement having been signed and
> emailed in.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
