[discuss] Commit policies

[Leif Hedstrom <zw...@apache.org>]

Hi all,

I'd like to open up the discussion on maybe having some "ground rules" 
for how we commit, build and test on trunk. I've started a draft on

     https://cwiki.apache.org/confluence/display/TS/CommitPolicies


and a few people have already made some modifications to it as well.

Please discuss :).

-- leif

Re: [discuss] Commit policies

[Leif Hedstrom <zw...@apache.org>]

I think we've finished this discussion, and there has been a lot of 
editing to the Wiki page. Unless someone objects (-1), the Wiki page now 
captures our commit policies:

     https://cwiki.apache.org/confluence/display/TS/CommitPolicies


Cheers,

-- leif

Re: [discuss] Commit policies

[Rainer Jung <ra...@kippdata.de>]

On 25.06.2010 19:19, Andrew Hsu wrote:
> FYI: I've added a section for describing the 'Author:' field of a commit
> log, mostly to remind myself of proper attribution upon commit :)
> https://cwiki.apache.org/confluence/display/TS/CommitPolicies

IMHO it is generally a good practice to obfuscate the email address, 
e.g. by replacing "@" and dots in the domain name by spaces. See e.g. 
the httpd changes file.

Of course that's not perfect.

Regards,

Rainer

Re: [discuss] Commit policies

[Andrew Hsu <an...@apache.org>]

FYI: I've added a section for describing the 'Author:' field of a commit
log, mostly to remind myself of proper attribution upon commit :)
https://cwiki.apache.org/confluence/display/TS/CommitPolicies

Re: [discuss] Commit policies

[John Plevyak <jp...@acm.org>]

+1

On 5/17/2010 6:20 PM, Leif Hedstrom wrote:
> On 05/17/2010 06:11 PM, Andrew Hsu wrote:
>> It may be useful to have a policy about commit log formats as well. 
>> An example of a commit log with jira ticket number that displays well
>> with git:
>>
>> TS-#### short summary (50 chars or less), not a sentence
>>
>> More detailed explanatory text, if necessary.  Wrap it to about 72
>> characters or so.  In some contexts, the first line is treated as the
>> subject of an email and the rest of the text as the body.  The blank
>> line separating the summary from the body is critical (unless you omit
>> the body entirely); tools like rebase can get confused if you run the
>> two together.
> 
> +1, add it to the Cwiki.
> 
> -- leif

Re: [discuss] Commit policies

[Leif Hedstrom <zw...@apache.org>]

On 05/17/2010 06:11 PM, Andrew Hsu wrote:
> It may be useful to have a policy about commit log formats as well.  
> An example of a commit log with jira ticket number that displays well 
> with git:
>
> TS-#### short summary (50 chars or less), not a sentence
>
> More detailed explanatory text, if necessary.  Wrap it to about 72
> characters or so.  In some contexts, the first line is treated as the
> subject of an email and the rest of the text as the body.  The blank
> line separating the summary from the body is critical (unless you omit
> the body entirely); tools like rebase can get confused if you run the
> two together.

+1, add it to the Cwiki.

-- leif

Re: [discuss] Commit policies

[Andrew Hsu <an...@apache.org>]

It may be useful to have a policy about commit log formats as well.  An 
example of a commit log with jira ticket number that displays well with git:

TS-#### short summary (50 chars or less), not a sentence

More detailed explanatory text, if necessary.  Wrap it to about 72
characters or so.  In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body.  The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.

On 5/17/10 1:29 PM, Leif Hedstrom wrote:
> Hi all,
>
> I'd like to open up the discussion on maybe having some "ground rules" 
> for how we commit, build and test on trunk. I've started a draft on
>
>     https://cwiki.apache.org/confluence/display/TS/CommitPolicies
>
>
> and a few people have already made some modifications to it as well.
>
> Please discuss :).
>
> -- leif
>