Hey all, Just wanted to ask: how do people like this new template?
While I think it's great to have instructions for people to write proper commit messages, I think the current template has a few downsides. - I tend to write verbose commit messages already when I'm preparing a PR. Now when I open the PR I have to edit the summary field to remove all the boilerplate. - The template ends up in the commit messages, and sometimes people forget to remove even the instructions. Instead, what about changing the template a bit so that it just has instructions prepended with some character, and have those lines removed by the merge_spark_pr.py script? We could then even throw in a link to the wiki as Sean suggested since it won't end up in the final commit messages. On Fri, Feb 19, 2016 at 11:53 AM, Reynold Xin <r...@databricks.com> wrote: > We can add that too - just need to figure out a good way so people don't > leave a lot of the unnecessary "guideline" messages in the template. > > The contributing guide is great, but unfortunately it is not as noticeable > and is often ignored. It's good to have this full-fledged contributing > guide, and then have a very lightweight version of that in the form of > templates to force contributors to think about all the important aspects > outlined in the contributing guide. > > > > > On Fri, Feb 19, 2016 at 2:36 AM, Sean Owen <so...@cloudera.com> wrote: >> >> All that seems fine. All of this is covered in the contributing wiki, >> which is linked from CONTRIBUTING.md (and should be from the >> template), but people don't seem to bother reading it. I don't mind >> duplicating some key points, and even a more explicit exhortation to >> read the whole wiki, before considering opening a PR. We spend way too >> much time asking people to fix things they should have taken 60 >> seconds to do correctly in the first place. >> >> On Fri, Feb 19, 2016 at 10:33 AM, Iulian Dragoș >> <iulian.dra...@typesafe.com> wrote: >> > It's a good idea. I would add in there the spec for the PR title. I >> > always >> > get wrong the order between Jira and component. >> > >> > Moreover, CONTRIBUTING.md is also lacking them. Any reason not to add it >> > there? I can open PRs for both, but maybe you want to keep that info on >> > the >> > wiki instead. >> > >> > iulian >> > >> > On Thu, Feb 18, 2016 at 4:18 AM, Reynold Xin <r...@databricks.com> >> > wrote: >> >> >> >> Github introduced a new feature today that allows projects to define >> >> templates for pull requests. I pushed a very simple template to the >> >> repository: >> >> >> >> >> >> https://github.com/apache/spark/blob/master/.github/PULL_REQUEST_TEMPLATE >> >> >> >> >> >> Over time I think we can see how this works and perhaps add a small >> >> checklist to the pull request template so contributors are reminded >> >> every >> >> time they submit a pull request the important things to do in a pull >> >> request >> >> (e.g. having proper tests). >> >> >> >> >> >> >> >> ## What changes were proposed in this pull request? >> >> >> >> (Please fill in changes proposed in this fix) >> >> >> >> >> >> ## How was the this patch tested? >> >> >> >> (Please explain how this patch was tested. E.g. unit tests, integration >> >> tests, manual tests) >> >> >> >> >> >> (If this patch involves UI changes, please attach a screenshot; >> >> otherwise, >> >> remove this) >> >> >> >> >> > >> > >> > >> > -- >> > >> > -- >> > Iulian Dragos >> > >> > ------ >> > Reactive Apps on the JVM >> > www.typesafe.com >> > > > -- Marcelo --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@spark.apache.org For additional commands, e-mail: dev-h...@spark.apache.org
