Git Workflow?

[Daniel Gruno <hu...@apache.org>]

I got to thinking about how we should work, and more specifically, how
we should accept PRs and such. jClouds has an excellent guide on this,
at https://cwiki.apache.org/confluence/display/JCLOUDS/Git+workflow and
I think we should try to follow their guidelines for Pony Mail.

Having a guide on this would eliminate nasties we might encounter with
some PRs.

Thoughts?

With regards,
Daniel.

Re: Git Workflow?

[Francesco Chicchiriccò <il...@apache.org>]

On 31/05/2016 09:24, Ulises wrote:
> I like the workflow. I'd change/add a small thing though:
>
> "Once the pull request is open and has been reviewed, address any review
> comments and add the changes in new commits. This will make it easier for
> the reviewer to focus only in the last changes without having to go again
> through the entire pull request."
>
> In my experience, it's also quiet beneficial to also squash into a single
> commit all the commits that have already been reviewed. This makes it a lot
> easier to review just the addressing of the reviewers' comments.

+1
We might say that it is fine to add as many commits as needed by reviews 
but, before merging, squashing is required.

Regards.

> On Tue, 31 May 2016 at 08:13 Francesco Chicchiricc� <il...@apache.org>
> wrote:
>
>> On 31/05/2016 09:07, Francesco Chicchiricc� wrote:
>>> On 31/05/2016 09:02, Daniel Gruno wrote:
>>>> On 05/31/2016 09:01 AM, Francesco Chicchiricc� wrote:
>>>>> On 31/05/2016 07:20, Daniel Gruno wrote:
>>>>>> I got to thinking about how we should work, and more specifically, how
>>>>>> we should accept PRs and such. jClouds has an excellent guide on this,
>>>>>> at https://cwiki.apache.org/confluence/display/JCLOUDS/Git+workflow
>>>>>> and
>>>>>> I think we should try to follow their guidelines for Pony Mail.
>>>>>>
>>>>>> Having a guide on this would eliminate nasties we might encounter with
>>>>>> some PRs.
>>>>> +1
>>>>>
>>>>> I've been contributing to jClouds in my early GIT days, and I've found
>>>>> ever since that such doc is quite good; in the following I've also been
>>>>> pointing others to it.
>>>>>
>>>>> Shall we "fork" that page in our website?
>>>> Yes, I think we should :)
>>>> And, erhm, change the various references from jClouds to Pony Mail, of
>>>> course ;D
>>>>
>>>> Would you be willing to get started on this, Francesco?
>>> The will is in, but I cannot guarantee any SLA - I am quite
>>> overwhelmed until the end of next week :-/
>> Anyway: are we going to put in place any tool to generate our website? I
>> would think we'll eventually have the need to add more pages besides
>> index.html.
>>
>> Regards.

-- 
Francesco Chicchiricc�

Tirasa - Open Source Excellence
http://www.tirasa.net/

Involved at The Apache Software Foundation:
member, Syncope PMC chair, Cocoon PMC, Olingo PMC,
CXF Committer, OpenJPA Committer, PonyMail PPMC
http://home.apache.org/~ilgrosso/

Re: Git Workflow?

[Daniel Gruno <hu...@apache.org>]

On 05/31/2016 09:24 AM, Ulises wrote:
> I like the workflow. I'd change/add a small thing though:
> 
> "Once the pull request is open and has been reviewed, address any review
> comments and add the changes in new commits. This will make it easier for
> the reviewer to focus only in the last changes without having to go again
> through the entire pull request."
> 
> In my experience, it's also quiet beneficial to also squash into a single
> commit all the commits that have already been reviewed. This makes it a lot
> easier to review just the addressing of the reviewers' comments.
> 
> U

I've added the workflow to
http://ponymail.incubator.apache.org/contribute.html - feel free to
change it :) You'll need to check out the site git repo and modify the
markdown file.

Repo is at:
https://git-wip-us.apache.org/repos/asf/incubator-ponymail-site.git
(there's a readme in the source dir)

With regards,
Daniel.

> 
> On Tue, 31 May 2016 at 08:13 Francesco Chicchiricc� <il...@apache.org>
> wrote:
> 
>> On 31/05/2016 09:07, Francesco Chicchiricc� wrote:
>>> On 31/05/2016 09:02, Daniel Gruno wrote:
>>>> On 05/31/2016 09:01 AM, Francesco Chicchiricc� wrote:
>>>>> On 31/05/2016 07:20, Daniel Gruno wrote:
>>>>>> I got to thinking about how we should work, and more specifically, how
>>>>>> we should accept PRs and such. jClouds has an excellent guide on this,
>>>>>> at https://cwiki.apache.org/confluence/display/JCLOUDS/Git+workflow
>>>>>> and
>>>>>> I think we should try to follow their guidelines for Pony Mail.
>>>>>>
>>>>>> Having a guide on this would eliminate nasties we might encounter with
>>>>>> some PRs.
>>>>> +1
>>>>>
>>>>> I've been contributing to jClouds in my early GIT days, and I've found
>>>>> ever since that such doc is quite good; in the following I've also been
>>>>> pointing others to it.
>>>>>
>>>>> Shall we "fork" that page in our website?
>>>> Yes, I think we should :)
>>>> And, erhm, change the various references from jClouds to Pony Mail, of
>>>> course ;D
>>>>
>>>> Would you be willing to get started on this, Francesco?
>>>
>>> The will is in, but I cannot guarantee any SLA - I am quite
>>> overwhelmed until the end of next week :-/
>>
>> Anyway: are we going to put in place any tool to generate our website? I
>> would think we'll eventually have the need to add more pages besides
>> index.html.
>>
>> Regards.
>>
>> --
>> Francesco Chicchiricc�
>>
>> Tirasa - Open Source Excellence
>> http://www.tirasa.net/
>>
>> Involved at The Apache Software Foundation:
>> member, Syncope PMC chair, Cocoon PMC, Olingo PMC,
>> CXF Committer, OpenJPA Committer, PonyMail PPMC
>> http://home.apache.org/~ilgrosso/
>>
>>
> 

Re: Git Workflow?

[Ulises <ul...@gmail.com>]

I like the workflow. I'd change/add a small thing though:

"Once the pull request is open and has been reviewed, address any review
comments and add the changes in new commits. This will make it easier for
the reviewer to focus only in the last changes without having to go again
through the entire pull request."

In my experience, it's also quiet beneficial to also squash into a single
commit all the commits that have already been reviewed. This makes it a lot
easier to review just the addressing of the reviewers' comments.

U

On Tue, 31 May 2016 at 08:13 Francesco Chicchiriccò <il...@apache.org>
wrote:

> On 31/05/2016 09:07, Francesco Chicchiriccò wrote:
> > On 31/05/2016 09:02, Daniel Gruno wrote:
> >> On 05/31/2016 09:01 AM, Francesco Chicchiriccò wrote:
> >>> On 31/05/2016 07:20, Daniel Gruno wrote:
> >>>> I got to thinking about how we should work, and more specifically, how
> >>>> we should accept PRs and such. jClouds has an excellent guide on this,
> >>>> at https://cwiki.apache.org/confluence/display/JCLOUDS/Git+workflow
> >>>> and
> >>>> I think we should try to follow their guidelines for Pony Mail.
> >>>>
> >>>> Having a guide on this would eliminate nasties we might encounter with
> >>>> some PRs.
> >>> +1
> >>>
> >>> I've been contributing to jClouds in my early GIT days, and I've found
> >>> ever since that such doc is quite good; in the following I've also been
> >>> pointing others to it.
> >>>
> >>> Shall we "fork" that page in our website?
> >> Yes, I think we should :)
> >> And, erhm, change the various references from jClouds to Pony Mail, of
> >> course ;D
> >>
> >> Would you be willing to get started on this, Francesco?
> >
> > The will is in, but I cannot guarantee any SLA - I am quite
> > overwhelmed until the end of next week :-/
>
> Anyway: are we going to put in place any tool to generate our website? I
> would think we'll eventually have the need to add more pages besides
> index.html.
>
> Regards.
>
> --
> Francesco Chicchiriccò
>
> Tirasa - Open Source Excellence
> http://www.tirasa.net/
>
> Involved at The Apache Software Foundation:
> member, Syncope PMC chair, Cocoon PMC, Olingo PMC,
> CXF Committer, OpenJPA Committer, PonyMail PPMC
> http://home.apache.org/~ilgrosso/
>
>

Re: Git Workflow?

[Ulises <ul...@gmail.com>]

Yes, squashing in as many logical commits as necessary (sometimes a single
commit is not the answer) should be a must IMO.

I was referring more to this sort of situation:
1. PR has 4 commits
2. $person reviews, leaves 2 comments
3. before addressing, the author of the PR squashes everything into as many
logical commits as necessary, i.e. get rid of commits that fix typos, etc.
4. address comments in new commits (perhaps 1 commit per comment addressed)
5. rinse and repeat

Before merging that PR, the commits should be squashed into as many commits
as necessary, always trying to keep the history as clean and logical as
possible.

On Tue, 31 May 2016 at 09:19 Francesco Chicchiriccò <il...@apache.org>
wrote:

> On 31/05/2016 09:51, Daniel Gruno wrote:
> > On 05/31/2016 09:12 AM, Francesco Chicchiriccò wrote:
> >> Anyway: are we going to put in place any tool to generate our website? I
> >> would think we'll eventually have the need to add more pages besides
> >> index.html.
> >>
> >> Regards.
> > I have split the web site into several markdown files now and added a
> > simple generator script. You simply modify the (or make a new) markdown
> > file(s) and run 'python3 generate.py' from the source/ dir to regenerate
> > the site. Hope this helps :) there's a primer doc in the source/ dir.
>
> Looks good!
> Regards.
>
> --
> Francesco Chicchiriccò
>
> Tirasa - Open Source Excellence
> http://www.tirasa.net/
>
> Involved at The Apache Software Foundation:
> member, Syncope PMC chair, Cocoon PMC, Olingo PMC,
> CXF Committer, OpenJPA Committer, PonyMail PPMC
> http://home.apache.org/~ilgrosso/
>
>

Re: Git Workflow?

[Francesco Chicchiriccò <il...@apache.org>]

On 31/05/2016 09:51, Daniel Gruno wrote:
> On 05/31/2016 09:12 AM, Francesco Chicchiricc� wrote:
>> Anyway: are we going to put in place any tool to generate our website? I
>> would think we'll eventually have the need to add more pages besides
>> index.html.
>>
>> Regards.
> I have split the web site into several markdown files now and added a
> simple generator script. You simply modify the (or make a new) markdown
> file(s) and run 'python3 generate.py' from the source/ dir to regenerate
> the site. Hope this helps :) there's a primer doc in the source/ dir.

Looks good!
Regards.

-- 
Francesco Chicchiricc�

Tirasa - Open Source Excellence
http://www.tirasa.net/

Involved at The Apache Software Foundation:
member, Syncope PMC chair, Cocoon PMC, Olingo PMC,
CXF Committer, OpenJPA Committer, PonyMail PPMC
http://home.apache.org/~ilgrosso/

Re: Git Workflow?

[Daniel Gruno <hu...@apache.org>]

On 05/31/2016 09:12 AM, Francesco Chicchiricc� wrote:
> 
> Anyway: are we going to put in place any tool to generate our website? I
> would think we'll eventually have the need to add more pages besides
> index.html.
> 
> Regards.
> 

I have split the web site into several markdown files now and added a
simple generator script. You simply modify the (or make a new) markdown
file(s) and run 'python3 generate.py' from the source/ dir to regenerate
the site. Hope this helps :) there's a primer doc in the source/ dir.

With regards,
Daniel.

Re: Git Workflow?

[Francesco Chicchiriccò <il...@apache.org>]

On 31/05/2016 09:07, Francesco Chicchiricc� wrote:
> On 31/05/2016 09:02, Daniel Gruno wrote:
>> On 05/31/2016 09:01 AM, Francesco Chicchiricc� wrote:
>>> On 31/05/2016 07:20, Daniel Gruno wrote:
>>>> I got to thinking about how we should work, and more specifically, how
>>>> we should accept PRs and such. jClouds has an excellent guide on this,
>>>> at https://cwiki.apache.org/confluence/display/JCLOUDS/Git+workflow 
>>>> and
>>>> I think we should try to follow their guidelines for Pony Mail.
>>>>
>>>> Having a guide on this would eliminate nasties we might encounter with
>>>> some PRs.
>>> +1
>>>
>>> I've been contributing to jClouds in my early GIT days, and I've found
>>> ever since that such doc is quite good; in the following I've also been
>>> pointing others to it.
>>>
>>> Shall we "fork" that page in our website?
>> Yes, I think we should :)
>> And, erhm, change the various references from jClouds to Pony Mail, of
>> course ;D
>>
>> Would you be willing to get started on this, Francesco?
>
> The will is in, but I cannot guarantee any SLA - I am quite 
> overwhelmed until the end of next week :-/

Anyway: are we going to put in place any tool to generate our website? I 
would think we'll eventually have the need to add more pages besides 
index.html.

Regards.

-- 
Francesco Chicchiricc�

Tirasa - Open Source Excellence
http://www.tirasa.net/

Involved at The Apache Software Foundation:
member, Syncope PMC chair, Cocoon PMC, Olingo PMC,
CXF Committer, OpenJPA Committer, PonyMail PPMC
http://home.apache.org/~ilgrosso/

Re: Git Workflow?

[Francesco Chicchiriccò <il...@apache.org>]

On 31/05/2016 09:02, Daniel Gruno wrote:
> On 05/31/2016 09:01 AM, Francesco Chicchiricc� wrote:
>> On 31/05/2016 07:20, Daniel Gruno wrote:
>>> I got to thinking about how we should work, and more specifically, how
>>> we should accept PRs and such. jClouds has an excellent guide on this,
>>> at https://cwiki.apache.org/confluence/display/JCLOUDS/Git+workflow and
>>> I think we should try to follow their guidelines for Pony Mail.
>>>
>>> Having a guide on this would eliminate nasties we might encounter with
>>> some PRs.
>> +1
>>
>> I've been contributing to jClouds in my early GIT days, and I've found
>> ever since that such doc is quite good; in the following I've also been
>> pointing others to it.
>>
>> Shall we "fork" that page in our website?
> Yes, I think we should :)
> And, erhm, change the various references from jClouds to Pony Mail, of
> course ;D
>
> Would you be willing to get started on this, Francesco?

The will is in, but I cannot guarantee any SLA - I am quite overwhelmed 
until the end of next week :-/

Regards.

-- 
Francesco Chicchiricc�

Tirasa - Open Source Excellence
http://www.tirasa.net/

Involved at The Apache Software Foundation:
member, Syncope PMC chair, Cocoon PMC, Olingo PMC,
CXF Committer, OpenJPA Committer, PonyMail PPMC
http://home.apache.org/~ilgrosso/

Re: Git Workflow?

[Daniel Gruno <hu...@apache.org>]

On 05/31/2016 09:01 AM, Francesco Chicchiricc� wrote:
> On 31/05/2016 07:20, Daniel Gruno wrote:
>> I got to thinking about how we should work, and more specifically, how
>> we should accept PRs and such. jClouds has an excellent guide on this,
>> at https://cwiki.apache.org/confluence/display/JCLOUDS/Git+workflow and
>> I think we should try to follow their guidelines for Pony Mail.
>>
>> Having a guide on this would eliminate nasties we might encounter with
>> some PRs.
> 
> +1
> 
> I've been contributing to jClouds in my early GIT days, and I've found
> ever since that such doc is quite good; in the following I've also been
> pointing others to it.
> 
> Shall we "fork" that page in our website?
> 
> Regards.
> 

Yes, I think we should :)
And, erhm, change the various references from jClouds to Pony Mail, of
course ;D

Would you be willing to get started on this, Francesco?

With regards,
Daniel.

Re: Git Workflow?

[Francesco Chicchiriccò <il...@apache.org>]

On 31/05/2016 07:20, Daniel Gruno wrote:
> I got to thinking about how we should work, and more specifically, how
> we should accept PRs and such. jClouds has an excellent guide on this,
> at https://cwiki.apache.org/confluence/display/JCLOUDS/Git+workflow and
> I think we should try to follow their guidelines for Pony Mail.
>
> Having a guide on this would eliminate nasties we might encounter with
> some PRs.

+1

I've been contributing to jClouds in my early GIT days, and I've found 
ever since that such doc is quite good; in the following I've also been 
pointing others to it.

Shall we "fork" that page in our website?

Regards.

-- 
Francesco Chicchiricc�

Tirasa - Open Source Excellence
http://www.tirasa.net/

Involved at The Apache Software Foundation:
member, Syncope PMC chair, Cocoon PMC, Olingo PMC,
CXF Committer, OpenJPA Committer, PonyMail PPMC
http://home.apache.org/~ilgrosso/