You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tuscany.apache.org by Ramkumar R <ra...@gmail.com> on 2008/11/17 08:44:11 UTC

[DISCUSS] Naming standard for modules/samples/itests projects

Hi All,

While running a complete build for sca-java-1.x branch, just noticed that
the names of projects in modules and itest are not uniform... for example

While most of the projects start with a name "Apache Tuscany SCA", few does
not comply to the standard..... as shown below.

In sca/java/modules:
- Apache Tuscany Java Interface for JAXWS
- Apache Tuscany Security Policy Model
- Apache Tuscany Reliability Policy Model
- Apache Tuscany Policy Model for JMS binding
- Apache Tuscany Policy Model for Axis2 WS binding
- Apache Tuscany OSGi Runtime Helper Library
- Apache Tuscany AOP-based Logging and Tracing
- Apache Tuscany Logging Policy Model
- Apache Tuscany Data Binding for FastInfoset

In sca/java/itest:
- Apache Tuscany Test for Callable References over Web Services
- Apache Tuscany Test for Simple Exceptions over Web Services
- Apache Tuscany Interface Integration Tests
- Unnamed - org.apache.tuscany.sca:itest-jms-args:jar:1.4-SNAPSHOT
- Apache Tuscany OSGi Contribution Version 2 classes
- Apache Tuscany OSGi Contribution Version 1 classes
- Apache Tuscany OSGi Contribution tests
- Apache Tuscany OSGi Contribution Tests

Just wanted to confirm, if we are following a standard in naming the
projects?

If we do follow, then we need to just change the names for the above listed
project by including a word "SCA" after "Apache Tuscany".

I will open a JIRA to take care of this one, once I get some comments from
others.

-- 
Thanks & Regards,
Ramkumar Ramalingam

Re: [DISCUSS] Naming standard for modules/samples/itests projects

Posted by haleh mahbod <hm...@gmail.com>.
This is a good idea and improves consumability. Would you please update the
development guide and include these naming conventions that project wants to
use to improve consumability?
Thanks,
Haleh

On Tue, Nov 18, 2008 at 3:27 AM, Ramkumar R <ra...@gmail.com> wrote:

> I have created TUSCANY-2678 to take care of this.
>
>
> On Tue, Nov 18, 2008 at 2:59 PM, Ramkumar R <ra...@gmail.com> wrote:
>
>> Hi Simon,
>>
>> I like your suggestion for the naming standards, +1 for implementing the
>> same.
>>
>> I will raise a JIRA to address the same.
>>
>> If any one has any comments, please let me know. Thanks.
>>
>>
>> On Mon, Nov 17, 2008 at 8:41 PM, Simon Laws <si...@googlemail.com>wrote:
>>
>>>
>>>
>>> On Mon, Nov 17, 2008 at 2:49 PM, Dan Becker <da...@gmail.com>wrote:
>>>
>>>> Hi Ram,
>>>>
>>>> Good scouting there. I think having a standard naming convention will
>>>> increase usability and make it easy for users to become acclimated. I vote
>>>> to proceed with implementing a standard naming convention.
>>>>
>>>>
>>>> Ramkumar R wrote:
>>>>
>>>>> While running a complete build for sca-java-1.x branch, just noticed
>>>>> that
>>>>> the names of projects in modules and itest are not uniform... for
>>>>> example
>>>>>
>>>>> While most of the projects start with a name "Apache Tuscany SCA", few
>>>>> does
>>>>> not comply to the standard..... as shown below.
>>>>>
>>>>> In sca/java/modules:
>>>>> - Apache Tuscany Java Interface for JAXWS
>>>>> - Apache Tuscany Security Policy Model
>>>>> - Apache Tuscany Reliability Policy Model
>>>>> - Apache Tuscany Policy Model for JMS binding
>>>>> - Apache Tuscany Policy Model for Axis2 WS binding
>>>>> - Apache Tuscany OSGi Runtime Helper Library
>>>>> - Apache Tuscany AOP-based Logging and Tracing
>>>>> - Apache Tuscany Logging Policy Model
>>>>> - Apache Tuscany Data Binding for FastInfoset
>>>>>
>>>>> In sca/java/itest:
>>>>> - Apache Tuscany Test for Callable References over Web Services
>>>>> - Apache Tuscany Test for Simple Exceptions over Web Services
>>>>> - Apache Tuscany Interface Integration Tests
>>>>> - Unnamed - org.apache.tuscany.sca:itest-jms-args:jar:1.4-SNAPSHOT
>>>>> - Apache Tuscany OSGi Contribution Version 2 classes
>>>>> - Apache Tuscany OSGi Contribution Version 1 classes
>>>>> - Apache Tuscany OSGi Contribution tests
>>>>> - Apache Tuscany OSGi Contribution Tests
>>>>>
>>>>> Just wanted to confirm, if we are following a standard in naming the
>>>>> projects?
>>>>>
>>>>>
>>>> --
>>>> Thanks, Dan Becker
>>>>
>>>
>>> +1 some of the names are either inconsistent or inaccurate so a tidy up
>>> here would be good. E.g
>>>
>>> Apache Tuscany "ModuleName "
>>>
>>> Seems to be the kind of pattern that we have for modules. Would be good
>>> to extend this so that samples, itests and demos are identifiable.
>>>
>>> Apache Tuscany itest "ModuleName "
>>> Apache Tuscany sample "ModuleName "
>>> Apache Tuscany demo "ModuleName "
>>>
>>> Simon
>>>
>>
>>
>>
>> --
>> Thanks & Regards,
>> Ramkumar Ramalingam
>>
>
>
>
> --
> Thanks & Regards,
> Ramkumar Ramalingam
>

Re: [DISCUSS] Naming standard for modules/samples/itests projects

Posted by Ramkumar R <ra...@gmail.com>.
I have created TUSCANY-2678 to take care of this.

On Tue, Nov 18, 2008 at 2:59 PM, Ramkumar R <ra...@gmail.com> wrote:

> Hi Simon,
>
> I like your suggestion for the naming standards, +1 for implementing the
> same.
>
> I will raise a JIRA to address the same.
>
> If any one has any comments, please let me know. Thanks.
>
>
> On Mon, Nov 17, 2008 at 8:41 PM, Simon Laws <si...@googlemail.com>wrote:
>
>>
>>
>> On Mon, Nov 17, 2008 at 2:49 PM, Dan Becker <da...@gmail.com>wrote:
>>
>>> Hi Ram,
>>>
>>> Good scouting there. I think having a standard naming convention will
>>> increase usability and make it easy for users to become acclimated. I vote
>>> to proceed with implementing a standard naming convention.
>>>
>>>
>>> Ramkumar R wrote:
>>>
>>>> While running a complete build for sca-java-1.x branch, just noticed
>>>> that
>>>> the names of projects in modules and itest are not uniform... for
>>>> example
>>>>
>>>> While most of the projects start with a name "Apache Tuscany SCA", few
>>>> does
>>>> not comply to the standard..... as shown below.
>>>>
>>>> In sca/java/modules:
>>>> - Apache Tuscany Java Interface for JAXWS
>>>> - Apache Tuscany Security Policy Model
>>>> - Apache Tuscany Reliability Policy Model
>>>> - Apache Tuscany Policy Model for JMS binding
>>>> - Apache Tuscany Policy Model for Axis2 WS binding
>>>> - Apache Tuscany OSGi Runtime Helper Library
>>>> - Apache Tuscany AOP-based Logging and Tracing
>>>> - Apache Tuscany Logging Policy Model
>>>> - Apache Tuscany Data Binding for FastInfoset
>>>>
>>>> In sca/java/itest:
>>>> - Apache Tuscany Test for Callable References over Web Services
>>>> - Apache Tuscany Test for Simple Exceptions over Web Services
>>>> - Apache Tuscany Interface Integration Tests
>>>> - Unnamed - org.apache.tuscany.sca:itest-jms-args:jar:1.4-SNAPSHOT
>>>> - Apache Tuscany OSGi Contribution Version 2 classes
>>>> - Apache Tuscany OSGi Contribution Version 1 classes
>>>> - Apache Tuscany OSGi Contribution tests
>>>> - Apache Tuscany OSGi Contribution Tests
>>>>
>>>> Just wanted to confirm, if we are following a standard in naming the
>>>> projects?
>>>>
>>>>
>>> --
>>> Thanks, Dan Becker
>>>
>>
>> +1 some of the names are either inconsistent or inaccurate so a tidy up
>> here would be good. E.g
>>
>> Apache Tuscany "ModuleName "
>>
>> Seems to be the kind of pattern that we have for modules. Would be good to
>> extend this so that samples, itests and demos are identifiable.
>>
>> Apache Tuscany itest "ModuleName "
>> Apache Tuscany sample "ModuleName "
>> Apache Tuscany demo "ModuleName "
>>
>> Simon
>>
>
>
>
> --
> Thanks & Regards,
> Ramkumar Ramalingam
>



-- 
Thanks & Regards,
Ramkumar Ramalingam

Re: [DISCUSS] Naming standard for modules/samples/itests projects

Posted by Ramkumar R <ra...@gmail.com>.
Hi Simon,

I like your suggestion for the naming standards, +1 for implementing the
same.

I will raise a JIRA to address the same.

If any one has any comments, please let me know. Thanks.

On Mon, Nov 17, 2008 at 8:41 PM, Simon Laws <si...@googlemail.com>wrote:

>
>
> On Mon, Nov 17, 2008 at 2:49 PM, Dan Becker <da...@gmail.com>wrote:
>
>> Hi Ram,
>>
>> Good scouting there. I think having a standard naming convention will
>> increase usability and make it easy for users to become acclimated. I vote
>> to proceed with implementing a standard naming convention.
>>
>>
>> Ramkumar R wrote:
>>
>>> While running a complete build for sca-java-1.x branch, just noticed that
>>> the names of projects in modules and itest are not uniform... for example
>>>
>>> While most of the projects start with a name "Apache Tuscany SCA", few
>>> does
>>> not comply to the standard..... as shown below.
>>>
>>> In sca/java/modules:
>>> - Apache Tuscany Java Interface for JAXWS
>>> - Apache Tuscany Security Policy Model
>>> - Apache Tuscany Reliability Policy Model
>>> - Apache Tuscany Policy Model for JMS binding
>>> - Apache Tuscany Policy Model for Axis2 WS binding
>>> - Apache Tuscany OSGi Runtime Helper Library
>>> - Apache Tuscany AOP-based Logging and Tracing
>>> - Apache Tuscany Logging Policy Model
>>> - Apache Tuscany Data Binding for FastInfoset
>>>
>>> In sca/java/itest:
>>> - Apache Tuscany Test for Callable References over Web Services
>>> - Apache Tuscany Test for Simple Exceptions over Web Services
>>> - Apache Tuscany Interface Integration Tests
>>> - Unnamed - org.apache.tuscany.sca:itest-jms-args:jar:1.4-SNAPSHOT
>>> - Apache Tuscany OSGi Contribution Version 2 classes
>>> - Apache Tuscany OSGi Contribution Version 1 classes
>>> - Apache Tuscany OSGi Contribution tests
>>> - Apache Tuscany OSGi Contribution Tests
>>>
>>> Just wanted to confirm, if we are following a standard in naming the
>>> projects?
>>>
>>>
>> --
>> Thanks, Dan Becker
>>
>
> +1 some of the names are either inconsistent or inaccurate so a tidy up
> here would be good. E.g
>
> Apache Tuscany "ModuleName "
>
> Seems to be the kind of pattern that we have for modules. Would be good to
> extend this so that samples, itests and demos are identifiable.
>
> Apache Tuscany itest "ModuleName "
> Apache Tuscany sample "ModuleName "
> Apache Tuscany demo "ModuleName "
>
> Simon
>



-- 
Thanks & Regards,
Ramkumar Ramalingam

Re: [DISCUSS] Naming standard for modules/samples/itests projects

Posted by Simon Laws <si...@googlemail.com>.
On Mon, Nov 17, 2008 at 2:49 PM, Dan Becker <da...@gmail.com> wrote:

> Hi Ram,
>
> Good scouting there. I think having a standard naming convention will
> increase usability and make it easy for users to become acclimated. I vote
> to proceed with implementing a standard naming convention.
>
>
> Ramkumar R wrote:
>
>> While running a complete build for sca-java-1.x branch, just noticed that
>> the names of projects in modules and itest are not uniform... for example
>>
>> While most of the projects start with a name "Apache Tuscany SCA", few
>> does
>> not comply to the standard..... as shown below.
>>
>> In sca/java/modules:
>> - Apache Tuscany Java Interface for JAXWS
>> - Apache Tuscany Security Policy Model
>> - Apache Tuscany Reliability Policy Model
>> - Apache Tuscany Policy Model for JMS binding
>> - Apache Tuscany Policy Model for Axis2 WS binding
>> - Apache Tuscany OSGi Runtime Helper Library
>> - Apache Tuscany AOP-based Logging and Tracing
>> - Apache Tuscany Logging Policy Model
>> - Apache Tuscany Data Binding for FastInfoset
>>
>> In sca/java/itest:
>> - Apache Tuscany Test for Callable References over Web Services
>> - Apache Tuscany Test for Simple Exceptions over Web Services
>> - Apache Tuscany Interface Integration Tests
>> - Unnamed - org.apache.tuscany.sca:itest-jms-args:jar:1.4-SNAPSHOT
>> - Apache Tuscany OSGi Contribution Version 2 classes
>> - Apache Tuscany OSGi Contribution Version 1 classes
>> - Apache Tuscany OSGi Contribution tests
>> - Apache Tuscany OSGi Contribution Tests
>>
>> Just wanted to confirm, if we are following a standard in naming the
>> projects?
>>
>>
> --
> Thanks, Dan Becker
>

+1 some of the names are either inconsistent or inaccurate so a tidy up here
would be good. E.g

Apache Tuscany "ModuleName "

Seems to be the kind of pattern that we have for modules. Would be good to
extend this so that samples, itests and demos are identifiable.

Apache Tuscany itest "ModuleName "
Apache Tuscany sample "ModuleName "
Apache Tuscany demo "ModuleName "

Simon

Re: [DISCUSS] Naming standard for modules/samples/itests projects

Posted by Dan Becker <da...@gmail.com>.
Hi Ram,

Good scouting there. I think having a standard naming convention will 
increase usability and make it easy for users to become acclimated. I 
vote to proceed with implementing a standard naming convention.

Ramkumar R wrote:
> While running a complete build for sca-java-1.x branch, just noticed that
> the names of projects in modules and itest are not uniform... for example
> 
> While most of the projects start with a name "Apache Tuscany SCA", few does
> not comply to the standard..... as shown below.
> 
> In sca/java/modules:
> - Apache Tuscany Java Interface for JAXWS
> - Apache Tuscany Security Policy Model
> - Apache Tuscany Reliability Policy Model
> - Apache Tuscany Policy Model for JMS binding
> - Apache Tuscany Policy Model for Axis2 WS binding
> - Apache Tuscany OSGi Runtime Helper Library
> - Apache Tuscany AOP-based Logging and Tracing
> - Apache Tuscany Logging Policy Model
> - Apache Tuscany Data Binding for FastInfoset
> 
> In sca/java/itest:
> - Apache Tuscany Test for Callable References over Web Services
> - Apache Tuscany Test for Simple Exceptions over Web Services
> - Apache Tuscany Interface Integration Tests
> - Unnamed - org.apache.tuscany.sca:itest-jms-args:jar:1.4-SNAPSHOT
> - Apache Tuscany OSGi Contribution Version 2 classes
> - Apache Tuscany OSGi Contribution Version 1 classes
> - Apache Tuscany OSGi Contribution tests
> - Apache Tuscany OSGi Contribution Tests
> 
> Just wanted to confirm, if we are following a standard in naming the
> projects?
> 

-- 
Thanks, Dan Becker