Hi,

Since we lost the dedicated document writer for Pig, would it make sense to require that going forward (0.12 and beyond) we require that documentation updates are included in the patch together with code changes and tests. I think that should work for most features/updates except perhaps big items that might require more than one JIRA to be completed before documentation changes make sense.

Comments?

Olga

As someone who chronically under-documents, I think that this is a good
idea. +1

2012/10/22 Olga Natkovich <[EMAIL PROTECTED]>

> Hi,
>
> Since we lost the dedicated document writer for Pig, would it make sense
> to require that going forward (0.12 and beyond) we require that
> documentation updates are included in the patch together with code changes
> and tests. I think that should work for most features/updates except
> perhaps big items that might require more than one JIRA to be completed
> before documentation changes make sense.
>
> Comments?
>
> Olga
>

+1
________________________________
 From: Jonathan Coveney <[EMAIL PROTECTED]>
To: [EMAIL PROTECTED]; Olga Natkovich <[EMAIL PROTECTED]>
Sent: Monday, October 22, 2012 5:09 PM
Subject: Re: PROPOSAL: how to handle release documentation going forward
 
As someone who chronically under-documents, I think that this is a good
idea. +1

2012/10/22 Olga Natkovich <[EMAIL PROTECTED]>

> Hi,
>
> Since we lost the dedicated document writer for Pig, would it make sense
> to require that going forward (0.12 and beyond) we require that
> documentation updates are included in the patch together with code changes
> and tests. I think that should work for most features/updates except
> perhaps big items that might require more than one JIRA to be completed
> before documentation changes make sense.
>
> Comments?
>
> Olga
>

I guess this is the only way to ensure documented code.

+1

We need to put this rule somewhere, maybe in the Wiki?

Cheers,
--
Gianmarco
On Tue, Oct 23, 2012 at 12:37 AM, Santhosh M S
<[EMAIL PROTECTED]> wrote:
> +1
>
>
> ________________________________
>  From: Jonathan Coveney <[EMAIL PROTECTED]>
> To: [EMAIL PROTECTED]; Olga Natkovich <[EMAIL PROTECTED]>
> Sent: Monday, October 22, 2012 5:09 PM
> Subject: Re: PROPOSAL: how to handle release documentation going forward
>
> As someone who chronically under-documents, I think that this is a good
> idea. +1
>
> 2012/10/22 Olga Natkovich <[EMAIL PROTECTED]>
>
>> Hi,
>>
>> Since we lost the dedicated document writer for Pig, would it make sense
>> to require that going forward (0.12 and beyond) we require that
>> documentation updates are included in the patch together with code changes
>> and tests. I think that should work for most features/updates except
>> perhaps big items that might require more than one JIRA to be completed
>> before documentation changes make sense.
>>
>> Comments?
>>
>> Olga
>>

Sounds good to me.
+1

On Tue, Oct 23, 2012 at 10:20 AM, Gianmarco De Francisci Morales <
[EMAIL PROTECTED]> wrote:

> I guess this is the only way to ensure documented code.
>
> +1
>
> We need to put this rule somewhere, maybe in the Wiki?
>
> Cheers,
> --
> Gianmarco
>
>
> On Tue, Oct 23, 2012 at 12:37 AM, Santhosh M S
> <[EMAIL PROTECTED]> wrote:
> > +1
> >
> >
> > ________________________________
> >  From: Jonathan Coveney <[EMAIL PROTECTED]>
> > To: [EMAIL PROTECTED]; Olga Natkovich <[EMAIL PROTECTED]>
> > Sent: Monday, October 22, 2012 5:09 PM
> > Subject: Re: PROPOSAL: how to handle release documentation going forward
> >
> > As someone who chronically under-documents, I think that this is a good
> > idea. +1
> >
> > 2012/10/22 Olga Natkovich <[EMAIL PROTECTED]>
> >
> >> Hi,
> >>
> >> Since we lost the dedicated document writer for Pig, would it make sense
> >> to require that going forward (0.12 and beyond) we require that
> >> documentation updates are included in the patch together with code
> changes
> >> and tests. I think that should work for most features/updates except
> >> perhaps big items that might require more than one JIRA to be completed
> >> before documentation changes make sense.
> >>
> >> Comments?
> >>
> >> Olga
> >>
>