On Mon, Sep 17, 2012 at 9:07 PM, Ben Caradoc-Davies <
[email protected]> wrote:

> +1.
>
> Thanks for bringing this up, Justin. Does the developer manual address
> this matter?
>

I am not sure, i don't believe so. Perhaps something under here:

  http://docs.geotools.org/latest/developer/conventions/index.html

Do we have a page on contributing? Like how to go about patches, etc... be
good if it were mentioned there as well.

>
> I find commit messages with only the Jira key to be a lot less helpful
> than they could be. Developers, please think of another developer looking
> at a long log listing. Or a maintainer considering your pull request.
>
> I like at a minimum the Jira key (GEOT-NNNN) and the Jira issue summary
> (title). If you do not have a Jira issue, I would like a description of why
> you made this change in the message. git will tell us *what* you changed; I
> want to know *why*.
>
> Kind regards,
> Ben.
>
>
> On 18/09/12 06:00, Justin Deoliveira wrote:
>
>> Hi folks,
>>
>> I have been noticing a few commit messages go by with no comment except
>> for the jira number they are related. While this is efficient (less
>> typing) it is also cumbersome for someone reviewing, or analyzing
>> history to have to go back to jira to figure out what the context. At
>> least a sentence would go a long way.
>>
>> Anyone else agree?
>>
>> -Justin
>>
>> --
>> Justin Deoliveira
>> OpenGeo - http://opengeo.org
>> Enterprise support for open source geospatial.
>>
>>
> --
> Ben Caradoc-Davies <[email protected]>
> Software Engineer
> CSIRO Earth Science and Resource Engineering
> Australian Resources Research Centre
>
>
>


-- 
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
GeoTools-Devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/geotools-devel

Reply via email to