You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Oleg Kalnichevski <ol...@apache.org> on 2006/04/28 10:02:45 UTC
Jira id naming convention for Jakarta projects; WAS Re: [all] Jira?
Henri Yandell wrote:
> On 4/27/06, Stephen Colebourne <sc...@btopenworld.com> wrote:
>
>> Henri Yandell wrote:
>>
>>> Given this positive feedback so far, I'm going to email the infra@
>>> mailing list to see how they would go about doing it _if_ we decided
>>> we wanted to move.
>>>
>>> I think we should be moving from 1 project with 37 components to 37
>>> projects - it'll allow us to manage the components individually of
>>> each other without the kind of version overlap and general noise
>>> issues that we currently have.
>>>
>> Jakarta Http Components just created their first Jira, and they got the
>> name JHCHTTPCORE. Thus this _could_ get caught up in a debate about
>> Jakarta and groupings.
>>
>
> That's the id-code rather than the name (afaik).
>
> I didn't know that that was being standardised - JHCHTTPCORE is
> terrible, sounds like a sneeze.
>
> Ideally we should use whatever we want, it's not a namespace to fight
> over, just need to be unique.
>
>
Henri,
I also find JHCHTTPCORE absolutely horrible. I chose this id as I
thought it would be the most "politically correct" one. I would very
much rather prefer HTTPCORE or JHTTPCORE. Do you envisage a particular
Jira id naming convention for Jakarta projects? At this point it is
still not too late for us to scrap the project and start over with a
different (better) project id.
Oleg
>> Personally, I'd like to see each component able to move grouping within
>> Jakarta, thus we should use naming like JAKLANG or JAKARTALANG, rather
>> than JLCLANG (for Jakarta Language Components).
>>
>> We also need to be aware that about half the commons websites now have
>> links tailored to bugzilla, and these links get placed into maven built
>> distributed projects. Another bit of work to do.
>>
>
> Not sure anything can be done about that one. Do you mean the sites
> that get stuck in the zips (by maven built distributed projects) or
> something else? I suspect that every project has had a period of cold
> turkey when it moved over. Any idea Martin? Is there a .htaccess in
> the Bugzilla somehow?
>
> Hen
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: Jira id naming convention for Jakarta projects; WAS Re: [all] Jira?
Posted by Thomas Dudziak <to...@gmail.com>.
On 4/28/06, Henri Yandell <fl...@gmail.com> wrote:
> I don't think it's important to have a scheme - it's just a project id
> that is used in such a way that users are aware of it. HCO, HTCO,
> JHTC. Doesn't matter and I agree with the Atlassian advice on it being
> a 3 or 4 letter code.
>
> So:
>
> LANG
> IO
> COLL
> CODX (though tempting to go with 5 letters when it fits, CODEC etc)
> ATTR
> BEAN
>
> etc.
>
> Dunno if that matches with the infra@ view. Having something with 11
> letters is a pain in the arse given that the only time I ever find
> myself using the id is: a) to discuss something outside of Jira and b)
> to enter into the find box in the top right.
I rarely if at all use the project names so for me at least their size
wouldn't matter. Besides, given the amount of projects at Jakarta, a
limitation of 3 or 4 makes it very hard to define meaningful names.
Not to mention that something like IO or LANG is quite generic - if
there would be projects that provide similar functionality in Perl or
C# then we would run into trouble (IO2, LANG2 ?). At least they could
be prefixed like this:
JAK_LANG
JAK_IO
JAK_COLL
JAK_CODEC
JAK_ATTR
JAK_BEAN
etc., or something similar.
cheers,
Tom
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: Jira id naming convention for Jakarta projects; WAS Re: [all] Jira?
Posted by Niall Pemberton <ni...@gmail.com>.
On 4/28/06, Henri Yandell <fl...@gmail.com> wrote:
> On 4/28/06, Oleg Kalnichevski <ol...@apache.org> wrote:
>
> > I also find JHCHTTPCORE absolutely horrible. I chose this id as I
> > thought it would be the most "politically correct" one. I would very
> > much rather prefer HTTPCORE or JHTTPCORE. Do you envisage a particular
> > Jira id naming convention for Jakarta projects? At this point it is
> > still not too late for us to scrap the project and start over with a
> > different (better) project id.
>
> I don't think it's important to have a scheme - it's just a project id
> that is used in such a way that users are aware of it. HCO, HTCO,
> JHTC. Doesn't matter and I agree with the Atlassian advice on it being
> a 3 or 4 letter code.
>
> So:
>
> LANG
> IO
> COLL
> CODX (though tempting to go with 5 letters when it fits, CODEC etc)
> ATTR
> BEAN
>
> etc.
>
> Dunno if that matches with the infra@ view. Having something with 11
> letters is a pain in the arse given that the only time I ever find
> myself using the id is: a) to discuss something outside of Jira and b)
> to enter into the find box in the top right.
...and commit messages - since jira can link to commits if you put the
issue number in the commit message. My preference would be something
more relevant rather than 3/4 characters (e.g. I prefer BEANUTILS to
BEAN) - also what about filtering for the jira messages sent to the
list - again wouldn't e.g. BEANUTILS be better?
Struts recently moved to jira - apparently this can't be changed once
its set - so it needs to be right from the start.
Niall
> Hen
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: Jira id naming convention for Jakarta projects; WAS Re: [all] Jira?
Posted by Greg Reddin <gr...@apache.org>.
On Apr 28, 2006, at 10:29 AM, Henri Yandell wrote:
>
> Dunno if that matches with the infra@ view. Having something with 11
> letters is a pain in the arse given that the only time I ever find
> myself using the id is: a) to discuss something outside of Jira and b)
> to enter into the find box in the top right.
You also have the ability to link svn commits to Jira tickets by
entering the ticket id in the commit message. Another reason for
going with short, but memorable id's.
Greg
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: Jira id naming convention for Jakarta projects; WAS Re: [all] Jira?
Posted by Henri Yandell <fl...@gmail.com>.
On 4/28/06, Oleg Kalnichevski <ol...@apache.org> wrote:
> I also find JHCHTTPCORE absolutely horrible. I chose this id as I
> thought it would be the most "politically correct" one. I would very
> much rather prefer HTTPCORE or JHTTPCORE. Do you envisage a particular
> Jira id naming convention for Jakarta projects? At this point it is
> still not too late for us to scrap the project and start over with a
> different (better) project id.
I don't think it's important to have a scheme - it's just a project id
that is used in such a way that users are aware of it. HCO, HTCO,
JHTC. Doesn't matter and I agree with the Atlassian advice on it being
a 3 or 4 letter code.
So:
LANG
IO
COLL
CODX (though tempting to go with 5 letters when it fits, CODEC etc)
ATTR
BEAN
etc.
Dunno if that matches with the infra@ view. Having something with 11
letters is a pain in the arse given that the only time I ever find
myself using the id is: a) to discuss something outside of Jira and b)
to enter into the find box in the top right.
Hen
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: Jira id naming convention for Jakarta projects; WAS Re: [all] Jira?
Posted by Henri Yandell <fl...@gmail.com>.
On 4/29/06, Oleg Kalnichevski <ol...@apache.org> wrote:
> On Fri, 2006-04-28 at 23:58 +0200, Dennis Lundberg wrote:
> > Henri Yandell wrote:
>
> > > In terms of the J***, we should we be asking infra@ what they want to do.
> >
> > If infra don't require us to use a prefix then we shouldn't use one.
> > Keep it as simple as possible, but still readable.
>
> Folks,
>
> Then I will go ahead and try to scrap the existing project and create a
> new one with JHTTPCORE as the project id. Please complain loudly if you
> have any objections to that.
Let me find out if Infra are worried about clash with prefix or not.
If not, then it'll be HTTPCORE.
Hen
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: Jira id naming convention for Jakarta projects; WAS Re: [all]
Jira?
Posted by Oleg Kalnichevski <ol...@apache.org>.
On Fri, 2006-04-28 at 23:58 +0200, Dennis Lundberg wrote:
> Henri Yandell wrote:
> > On 4/28/06, Dennis Lundberg <de...@apache.org> wrote:
> >
> >> I think that having a naming scheme is a good idea. From a user
> >> standpoint I see no reason for keeping the project ids short (3-4
> >> characters). If Jakarta will be sharing the Jira instance with other ASF
> >> projects then using a J prefix for Jakarta project should be used, like
> >> this:
> >> - JLANG
> >> - JDIGESTER
> >> - JCOLLECTIONS
> >> - JHTTPCORE
> >
> > It does seem to be that there's more interest in the full name than
> > the shorter one.
> >
> > In terms of the J***, we should we be asking infra@ what they want to do.
>
> If infra don't require us to use a prefix then we shouldn't use one.
> Keep it as simple as possible, but still readable.
Folks,
Then I will go ahead and try to scrap the existing project and create a
new one with JHTTPCORE as the project id. Please complain loudly if you
have any objections to that.
Oleg
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: Jira id naming convention for Jakarta projects; WAS Re: [all]
Jira?
Posted by Dennis Lundberg <de...@apache.org>.
Henri Yandell wrote:
> On 4/28/06, Dennis Lundberg <de...@apache.org> wrote:
>
>> I think that having a naming scheme is a good idea. From a user
>> standpoint I see no reason for keeping the project ids short (3-4
>> characters). If Jakarta will be sharing the Jira instance with other ASF
>> projects then using a J prefix for Jakarta project should be used, like
>> this:
>> - JLANG
>> - JDIGESTER
>> - JCOLLECTIONS
>> - JHTTPCORE
>
> It does seem to be that there's more interest in the full name than
> the shorter one.
>
> In terms of the J***, we should we be asking infra@ what they want to do.
If infra don't require us to use a prefix then we shouldn't use one.
Keep it as simple as possible, but still readable.
<snip/>
> In terms of ids, obviously one for each project. Do we also want one
> for Commons in general for build and site issues? And I presume we'd
> have a sandbox project.
How about COMMONS for general commons stuff? And perhaps JAKARTA as well.
We could either use SANDBOX for all sandbox components or create one id
for each sandbox component.
--
Dennis Lundberg
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: Jira id naming convention for Jakarta projects; WAS Re: [all] Jira?
Posted by Rahul Akolkar <ra...@gmail.com>.
On 4/28/06, Henri Yandell <fl...@gmail.com> wrote:
<snip/>
>
> It does seem to be that there's more interest in the full name than
> the shorter one.
>
<snap/>
I don't think we should imply a x character limit either. Hopefully,
everyone will choose the shortest name that still makes sense.
> In terms of the J***, we should we be asking infra@ what they want to do.
>
> I don't think we should be embracing the J*** bit out of future-worry
> if they're not concerned. I can agree that a more readable code makes
> for more readable email subjects (the name is in the body of the jira
> email not the subject, so hard to filter on that); but the prefixing
> with J issue then makes it unreadable and doesn't seem necessary.
>
<snip/>
Agreed, lets not have prefixes please.
>
> In terms of ids, obviously one for each project. Do we also want one
> for Commons in general for build and site issues?
<snip/>
Yes.
> And I presume we'd
> have a sandbox project.
>
<snap/>
Yes.
Also, are we talking about migrating Commons or Jakarta to JIRA?
Finally, take my comments for what they're worth since unfortunately,
I have no cycles to contribute towards this move.
-Rahul
> Hen
>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: Jira id naming convention for Jakarta projects; WAS Re: [all] Jira?
Posted by Henri Yandell <fl...@gmail.com>.
On 4/28/06, Dennis Lundberg <de...@apache.org> wrote:
> I think that having a naming scheme is a good idea. From a user
> standpoint I see no reason for keeping the project ids short (3-4
> characters). If Jakarta will be sharing the Jira instance with other ASF
> projects then using a J prefix for Jakarta project should be used, like
> this:
> - JLANG
> - JDIGESTER
> - JCOLLECTIONS
> - JHTTPCORE
It does seem to be that there's more interest in the full name than
the shorter one.
In terms of the J***, we should we be asking infra@ what they want to do.
I don't think we should be embracing the J*** bit out of future-worry
if they're not concerned. I can agree that a more readable code makes
for more readable email subjects (the name is in the body of the jira
email not the subject, so hard to filter on that); but the prefixing
with J issue then makes it unreadable and doesn't seem necessary.
> If we can have our own Jira instance for Jakarta then the prefix can
> easily be dropped. I'm not subscribes to infra@ so I don't follow the
> discussions there.
Talked to Jeff about this. It won't be its own instance. Aim is to
keep things in the one instance. The current extra instances are
temporary until they can be sucked into the main one.
In terms of ids, obviously one for each project. Do we also want one
for Commons in general for build and site issues? And I presume we'd
have a sandbox project.
Hen
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: Jira id naming convention for Jakarta projects; WAS Re: [all]
Jira?
Posted by Dennis Lundberg <de...@apache.org>.
Oleg Kalnichevski wrote:
> Henri Yandell wrote:
>> On 4/27/06, Stephen Colebourne <sc...@btopenworld.com> wrote:
>>
>>> Henri Yandell wrote:
>>>
>>>> Given this positive feedback so far, I'm going to email the infra@
>>>> mailing list to see how they would go about doing it _if_ we decided
>>>> we wanted to move.
>>>>
>>>> I think we should be moving from 1 project with 37 components to 37
>>>> projects - it'll allow us to manage the components individually of
>>>> each other without the kind of version overlap and general noise
>>>> issues that we currently have.
>>>>
>>> Jakarta Http Components just created their first Jira, and they got the
>>> name JHCHTTPCORE. Thus this _could_ get caught up in a debate about
>>> Jakarta and groupings.
>>>
>>
>> That's the id-code rather than the name (afaik).
>>
>> I didn't know that that was being standardised - JHCHTTPCORE is
>> terrible, sounds like a sneeze.
>>
>> Ideally we should use whatever we want, it's not a namespace to fight
>> over, just need to be unique.
>>
>>
> Henri,
>
> I also find JHCHTTPCORE absolutely horrible. I chose this id as I
> thought it would be the most "politically correct" one. I would very
> much rather prefer HTTPCORE or JHTTPCORE. Do you envisage a particular
> Jira id naming convention for Jakarta projects? At this point it is
> still not too late for us to scrap the project and start over with a
> different (better) project id.
It would be a good idea to look at what the Maven community has done
with Jira. They have used Jira for some time now. They have their Jira
over at Codehaus and share the Jira instance with other projects:
http://jira.codehaus.org/secure/BrowseProjects.jspa
They have a naming scheme that prefixes all Maven 2 plugins with M. This
is followed by the plugins name. They don't use fancy acronyms which are
hard to read or remember. Some examples:
- MANT
- MJAVADOC
- MCHECKSTYLE
I think that having a naming scheme is a good idea. From a user
standpoint I see no reason for keeping the project ids short (3-4
characters). If Jakarta will be sharing the Jira instance with other ASF
projects then using a J prefix for Jakarta project should be used, like
this:
- JLANG
- JDIGESTER
- JCOLLECTIONS
- JHTTPCORE
If we can have our own Jira instance for Jakarta then the prefix can
easily be dropped. I'm not subscribes to infra@ so I don't follow the
discussions there.
As mentioned elsewhere the project id will show up in the issue-emails
that are sent to the dev-list. Having meaningful ids there helps human
filtering as well as automatic mail filters.
<snip>
--
Dennis Lundberg
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org