[seam-dev] Example names

Gunnar Morling gunnar.morling at googlemail.com
Sun Feb 27 16:44:57 EST 2011


+1 for making this more consistent.

Another issue are the folder names of the examples. I think the top level
folder should always be "examples", even if there is only one example atm.
(I'll change this for validation). To stay consistent with the naming
pattern for the actual module folders, under "examples" the names shouldn't
be prefixed in any way, but have the example's name only, e.g. "helloworld".
This is already the case nearly everywhere with some exclusions (e.g.
international). WDYT?

The proposal for the artifact names looks good. It's a good idea to always
use a concrete example name from the beginning (such as
seam-validation-example-helloworld instead of seam-validation-example), also
if there is only one example atm. That way the name doesn't have to be
altered if other examples are added later on.

Gunnar


2011/2/27 Shane Bryzak <sbryzak at redhat.com>

> Guys, we've got to come up with a standard naming scheme for our example
> names, because the ones we have look like an rhinoceros sat on them or
> something:
>
> helloworld
> idmconsole
> model
> openid-rp
> princess-rescue
> seam-catch-example-basic-servlet
> seam-international-example-timeanddate
> seam-jaxrs-exceptions
> seam-tasks-statistics
> seam-wicket-example-numberguess
> short.ly
> simple
> validation
> validation-helloworld
>
> I'm just as guilty as anyone else (in fact I think mine are the most
> ambiguous of all).  What I propose to clean this up is to prefix the
> example name with the module name - e.g:
>
> helloworld becomes remoting-helloworld
> simple becomes security-simple
>
> You get the idea.  Also, the Maven artifact names for the examples
> should be standardised too.  We currently have all sorts of variations
> here also, so how about we use seam-{module}-example-{name}, as this
> seems to be what most people are already using (and therefore would
> require the least work).
>
> Using the previous two examples, that would give us artifact names like so:
>
> seam-remoting-example-helloworld
> seam-security-example-simple
>
> What do you think?
> _______________________________________________
> seam-dev mailing list
> seam-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/seam-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/seam-dev/attachments/20110227/68a48af7/attachment.html 


More information about the seam-dev mailing list