Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [ormf-dev] Naming conventions for exemplary tool


Typically the pattern is
org.eclipse.project. component.subcomponent.internal.class
or
org.eclipse.project, component,subcomponent.provisional.class
or
org.eclipse.project, component,subcomponent.class

using the server/client component area is common.
Picture the names in the cvs hierarchy like a decision tree of progressive disclosure  to find the code ;-)
I am not suer useme needs to exist anywhere. Your heritage should not be confused with the new project. Think about how a new developer wanting to extend the project by API would want to look at the source tree.


We learned the hard way in Hyades/TPTP because we were around almost at day 1 when the best practices where still being written. We created some reference material other projects have also found useful here. The platform folks have gotten pretty good ad describing the practices they have followed as well.

Thanks for your time.
________________
Harm Sluiman,
IBM DE / Technical Executive
phone:905-413-4032   fax: 4920  cell: 1-647-300-4758
mailto:sluiman@xxxxxxxxxx
Admin : Queenie Lam qlam@xxxxxxxxxx  Tie: 313-5864 1-905-413-5864



Flavelle Ballem <fballem@xxxxxxxxxxxx>
Sent by: ormf-dev-bounces@xxxxxxxxxxx

08/06/2008 05:24 PM

Please respond to
The Open Requirements Management Framework project development list        <ormf-dev@xxxxxxxxxxx>

To
The Open Requirements Management Framework project development list <ormf-dev@xxxxxxxxxxx>
cc
Subject
Re: [ormf-dev] Naming conventions for exemplary tool





At the risk of stating the obvious, may I ask what's wrong with:

org.eclipse.ormf.client.editor.useme

It is possible, over time, that there may be other editors that build use cases. Useme strikes me as being a specific process with a specific set of requirements for building use cases. The question would then arise as to how difficult it would be to segregate the reporting parts of useme from the editor parts. If that is doable, then the reporting parts would logically be:

org.eclipse.ormf.client.reporting.useme


Just a thought,
Flavelle




Joel Rosi-Schwartz wrote:

If anyone even thinks about telling us to "get a life" I think I have to forewarn them that the suggestion will lead to am immediate panic and is likely to drive us into despair.  

sigh...
/joel


On 6 Aug 2008, at 21:57, Barbara Rosi-Schwartz wrote:

Beloved Mentors,

Joel and I have been trying to come up with an appropriate plug-in naming convention for the Useme related plug-ins as opposed to the framework plug-ins, but so far we have not succeeded. I guess the most important and fundamental question is: does the framework acronym (ormf) need to appear in the name or not? We have scrounged around the ecosystem for examples but have not been able to find any suitable ones.

Here are a few permutations we have tried, all of them unsatisfactory to us for one reason or another:

org.eclipse.ormf.client.editor.usecase - the name we have now, but lacks reference to Useme (the actual tool name)
org.eclipse.ormf.useme.client.editor.usecase - clumsy and not easy for future tools to follow
org.eclipse.ormf.client.editor.useme.usecase - indicates that all tools fall into the editor namespace which is not necessarily true (there could be reporting tools, for instance)
org.eclipse.useme.client.editor.usecase - looses the fact that it is built on ORMF

Any suggestions or guidelines? (Please refrain from the obvious suggestion: "Get a life!"...  ;-)

Thank you muchly, as always.
B.

P   Please consider the environment before printing this e-mail. Thank you.

<pastedGraphic.tiff>
http://www.etish.org          <pastedGraphic.tiff>http://www.eclipse.org/ormf

<pastedGraphic.tiff>
http://www.linkedin.com/profile?viewProfile=&key=19433011

<pastedGraphic.tiff>


_______________________________________________
ormf-dev mailing list

ormf-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/ormf-dev




_______________________________________________
ormf-dev mailing list
ormf-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/ormf-dev
 
_______________________________________________
ormf-dev mailing list
ormf-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/ormf-dev


Back to the top