Best Practices for Creating and Merging PRs

[Luciano Resende <lu...@gmail.com>]

Do we have any set of recommendations on creating and Merging PRs for the
Toree Project ?

At least on the Merging side, I would like to recommend that we avoid using
the GitHub merge PR button as that causes a bunch of not useful commits to
be displayed in the commit history such as: "Merging pr #101" which does
not provide any information about what the change is, etc...

If folks are ok, I would also like to propose we start using the Spark
recommendation for creating PRs or commits which I summarized in [1]

[1]
https://github.com/SparkTC/development-guidelines/blob/master/project-contribution-guidelines.md#creating-a-pull-request

Thoughts ?

-- 
Luciano Resende
http://twitter.com/lresende1975
http://lresende.blogspot.com/

Re: Best Practices for Creating and Merging PRs

[Chip Senkbeil <ch...@gmail.com>]

We don't have access to the GitHub merge PR button, do we? That I'm aware
of, Gino, Corey, and I have been manually merging fully-rebased PRs to keep
a clean commit history.

If the GitHub merge PR button was available, we could use the
squash-and-rebase option, which provides a very clean way to both reduce
the amount of commits and ensure the history is ordered properly. To me, it
is the most modern and sensible approach. I would do that manually if I had
a way to mark the PRs on Github as merged afterward.

As for providing guidelines for PRs, I'm not sure if there is much of a
point until we get a higher volume of traffic where we need to increase
structure. We could at least encourage PRs that have the JIRA issue number
in the title. That makes sense.

On Mon, Mar 6, 2017 at 10:10 AM Luciano Resende <lu...@gmail.com>
wrote:

> Do we have any set of recommendations on creating and Merging PRs for the
> Toree Project ?
>
> At least on the Merging side, I would like to recommend that we avoid using
> the GitHub merge PR button as that causes a bunch of not useful commits to
> be displayed in the commit history such as: "Merging pr #101" which does
> not provide any information about what the change is, etc...
>
> If folks are ok, I would also like to propose we start using the Spark
> recommendation for creating PRs or commits which I summarized in [1]
>
> [1]
>
> https://github.com/SparkTC/development-guidelines/blob/master/project-contribution-guidelines.md#creating-a-pull-request
>
> Thoughts ?
>
> --
> Luciano Resende
> http://twitter.com/lresende1975
> http://lresende.blogspot.com/
>