Re: naming conventions (was Re: Connector Framewo0rk)

[Scott Wilson <sc...@gmail.com>]

On 21 Mar 2011, at 12:48, Ross Gardler wrote:

> On 21/03/2011 11:44, Scott Wilson wrote:
>> On 21 Mar 2011, at 11:15, Michael Aram wrote:
>> 
>>> Dear Wookie-Community,
>>> 
>>> 
>> 
>> (I'll leave the connectors issue for those more familiar with them to
>> comment on...)
>> 
>>> * Cleaning up the whole identifier mess by enforcing naming
>>> conventions *
> 
> ...
> 
>>> Therefore, I would recommend to create a small set of "naming
>>> conventions" for those critical variable names, like "always call
>>> a widget's guid "widgetGuid" when writing code/documentation" or
>>> "never use the word "widget" when refering to a widget-instance";
>>> and to do a small refactoring before the first Wookie release.
>> 
>> +1 on creating naming conventions for these terms; I've noticed the
>> same thing myself. I don't know about doing it before the first
>> release - I think we ought do this for the second release (0.9.1)
>> rather than delay the initial release further.
> 
> +1 I also am confused. If we are confused it's no wonder Michael is confused. Lets sort this mess out.
> 
> +1 for doing it in 0.9.1

I'd like to get started on this - is the wiki the right place to do it, or should I create a file in the in-progress website structure at:

http://svn.apache.org/repos/asf/incubator/wookie/site/trunk/content/wookie/docs/developer/

?

Also - does anyone have any favourite examples of this type of page from other projects?

> 
>> See also https://issues.apache.org/jira/browse/WOOKIE-34 and
>> http://incubator.apache.org/wookie/strawman-for-082.html (where we
>> can also propose changing the instance XML representation in line
>> with agreed conventions)
> 
> +1 lets align all these thoughts.
> 
>> Michael - would you like to submit a draft text for the conventions?
>> It sounds like you've got a good handle on the issue.
> 
> +1000 - please Michael.
> 
> I'll be at the Bolton event next week, happy to do some work with you on this and come up with a draft proposal for the list.
> 
> (assuming we can find the time in the schedule)
> 
> Ross
> 
> -- 
> rgardler@apache.org
> @rgardler