[jira] [Commented] (MATH-1357) Create Github Pull Request Template

["Gilles (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/MATH-1357?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15245388#comment-15245388 ] 

Gilles commented on MATH-1357:
------------------------------

bq. a directory named {{.github}}

Is there a reason for a hidden directory?

Couldn't we just have an additional (simple text) document under
{noformat}
doc/development/
{noformat}
with a step-by-step procedure for contributing to CM using Github?
And the template would also be in that directory (formatted with "markdown" if you want).

bq. A checkbox for the apache contributor agreement having been signed and emailed in.

I'm not sure it is required.
I'm also a bit wary that it could put off some one-time contributors.


> 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)