spark-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Sean Owen <so...@cloudera.com>
Subject Re: Suggestion in README.md for guiding pull requests/JIRAs (probably about linking CONTRIBUTING.md or wiki)
Date Sun, 09 Oct 2016 16:33:57 GMT
Yes, it's really CONTRIBUTING.md that's more relevant, because github
displays a link to it when opening pull requests.
https://github.com/apache/spark/blob/master/CONTRIBUTING.md  There is also
the pull request template:
https://github.com/apache/spark/blob/master/.github/PULL_REQUEST_TEMPLATE

I wouldn't want to duplicate info too much, but more pointers to a single
source of information seems OK. Although I don't know if it will help much,
sure, pointers from README.md are OK.

On Sun, Oct 9, 2016 at 3:47 PM Hyukjin Kwon <gurwls223@gmail.com> wrote:

> Hi all,
>
>
> I just noticed the README.md (https://github.com/apache/spark) does not
> describe the steps or links to follow for creating a PR or JIRA directly. I
> know probably it is sensible to search google about the contribution guides
> first before trying to make a PR/JIRA but I think it seems not enough when
> I see some inappropriate PRs/JIRAs time to time.
>
> I guess flooding JIRAs and PRs is problematic (assuming from the emails
> in dev mailing list) and I think we should explicitly mention and describe
> this in the README.md and pull request template[1].
>
> (I know we have CONTBITUTING.md[2] and wiki[3] but it seems pretty true
> that we still have some PRs or JIRAs not following the documentation.)
>
> So, my suggestions are as below:
>
> - Create a section maybe "Contributing To Apache Spark" describing the
> Wiki and CONTRIBUTING.md[2] in the README.md.
>
> - Describe an explicit warning in pull request template[1], for example,
> "Please double check if your pull request is from a branch to a branch. In
> most cases, this change is not appropriate. Please ask to mailing list (
> http://spark.apache.org/community.html) if you are not sure."
>
> [1]
> https://github.com/apache/spark/blob/master/.github/PULL_REQUEST_TEMPLATE
> [2]https://github.com/apache/spark/blob/master/CONTRIBUTING.md
> [3]https://cwiki.apache.org/confluence/display/SPARK/Wiki+Homepage
>
>
> Thank you all.
>

Mime
View raw message