You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@spark.apache.org by "Reynold Xin (JIRA)" <ji...@apache.org> on 2016/10/10 00:38:20 UTC
[jira] [Commented] (SPARK-17840) Add some pointers for
wiki/CONTRIBUTING.md in README.md and some warnings in
PULL_REQUEST_TEMPLATE
[ https://issues.apache.org/jira/browse/SPARK-17840?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15560914#comment-15560914 ]
Reynold Xin commented on SPARK-17840:
-------------------------------------
My comment on the dev list email thread:
Github already links to CONTRIBUTING.md. -- of course, a lot of people ignore that. One thing we can do is to add an explicit link to the wiki contributing page in the template (but note that even that introduces some overhead for every pull request).
Aside from that, I am not sure if the other suggestions in the JIRA ticket are necessary. For example, the issue with creating a pull request from one branch to another is a problem, but it happens perhaps less than once a week and is trivially closeable. Adding an explicit warning there will fix some cases, but won't entirely eliminate the problem (because I'm sure a lot of people still don't read the template), and will introduce another overhead for everybody who submits the proper way.
> Add some pointers for wiki/CONTRIBUTING.md in README.md and some warnings in PULL_REQUEST_TEMPLATE
> --------------------------------------------------------------------------------------------------
>
> Key: SPARK-17840
> URL: https://issues.apache.org/jira/browse/SPARK-17840
> Project: Spark
> Issue Type: Documentation
> Components: Documentation
> Reporter: Hyukjin Kwon
> Priority: Trivial
>
> It seems it'd better to give best efforts for describing the guides for creating JIRAs and PRs as there are several discussions about this.
> Maybe,
> - We could add some pointers of {{CONTRIBUTING.md}} or wiki[1] in README.md
> - Adds an explicit warning in PULL_REQUEST_TEMPLATE[2], in particular, for some PRs trying to merge a branch to another branch, for example as below:
> {quote}
> Please double check if your pull request is from a branch to a branch. It is probably wrong if the pull request title is "Branch 2.0" or "Merge ..." or if your pull request includes many commit logs unrelated to your changes to propose.
> {quote}
> Please refer the mailing list[3].
> [1] https://cwiki.apache.org/confluence/display/SPARK/Contributing+to+Spark
> [2] https://github.com/apache/spark/blob/master/.github/PULL_REQUEST_TEMPLATE
> [3] http://mail-archives.apache.org/mod_mbox/spark-dev/201610.mbox/%3CCAMAsSdKYEvvU%2BPdZ0oFDsvwod6wRRavqRyYmjc7qYhEp7%2B_3eg%40mail.gmail.com%3E
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org