Re: [jakarta.ee-spec.committee] GitHub repository naming conventions?

["Kevin Sutter" <sutter@xxxxxxxxxx>]

Bill,
Personally, I
don't think we have to establish rules for the repo organization.  I
think all three (spec, api, and tck) could reside in the same repo.  We
do that with MicroProfile and it's been working out just fine.  Maybe
that could be the recommendation, but each project could decide for themselves
-- one, two, or three repos.

As far as naming,
some type of convention would probably be nice to easily determine the
contents.  But, if we don't require a certain number of repos, then
maybe the only convention is wombat-<something>.

As far as the
github pages or wiki content, my take is that should be left up to the
project as well.  If the project is going to do more than just README
files in their github repos, then I would suggest that they create a separate
wombat-pages or wombat-wiki repo to house that type of information (instead
of mixing it up with the spec, api, and tck content).

---------------------------------------------------
Kevin Sutter 
STSM, MicroProfile and Jakarta EE architect
e-mail:  sutter@xxxxxxxxxx     Twitter:  @kwsutter
phone: tl-553-3620 (office), 507-253-3620 (office)    
LinkedIn: https://www.linkedin.com/in/kevinwsutter



From:
       Bill
Shannon <bill.shannon@xxxxxxxxxx>
To:
       Jakarta
specification committee <jakarta.ee-spec.committee@xxxxxxxxxxx>,
Scott Stark <sstark@xxxxxxxxxx>
Date:
       06/19/2019
01:03 AM
Subject:
       [EXTERNAL]
Re: [jakarta.ee-spec.committee] GitHub repository naming    
   conventions?
Sent
by:        jakarta.ee-spec.committee-bounces@xxxxxxxxxxx

---

Why do you think they should all be in
the same repo?

Clearly the spec, API, and TCK will all be part of the same project,
which controls who has permission to do what.  Why would two of them
be in one repo and one of them in another repo?


Scott Stark wrote on 6/18/19 9:20 PM:
I do believe the spec and api should
be in the same repo. The TCKs should be in a separate repo. 

github.com/eclipse-ee4j/wombat-spec/{spec,
api}
github.com/eclipse-ee4j/wombat-tck


On Jun 18, 2019, at 9:06 PM, Bill Shannon
<bill.shannon@xxxxxxxxxx>
wrote:

Anyone else have an opinion?

Do we want to establish any conventions or guidelines or (heaven forbid)
rules?

I'm not sure putting the spec document in the same repo as the API classes
is the best choice, but really I'm much more concerned about having some
consistency in where to go for the web site with information about each
spec.


Wayne Beaton wrote on 6/18/19 7:32 PM:
I have no strong opinion. 

The PMC has made a recommendation that
specification documents be represented in existing API repositories. At
least a few project teams have expressed a desire to do this. I'm sure
that some project teams will make other decisions. So, there will likely
be few "wombat-spec" repositories.

As part of the restructuring review,
I am assuming that projects will use existing "API" repositories.
If a project team wants a separate "spec" repository, they can
ask for one.

Wayne

On Tue, Jun 18, 2019 at 6:22 PM Bill
Shannon <bill.shannon@xxxxxxxxxx>
wrote:

Have we decided on naming conventions for the GitHub repositories
that are part of specification projects?  For example, will we have

github.com/eclipse-ee4j/wombat-spec
github.com/eclipse-ee4j/wombat-tck
github.com/eclipse-ee4j/wombat-api

(Ignoring the eventual "eclipse-ee4j" -> "jakartaee" renaming.)

Will there be a

github.com/eclipse-ee4j/wombat

repository?  And what would it contain?

Which one of the above repositories would host the GitHub Pages web site?
eclipse-ee4j.github.io/wombat-spec?

Would we expect GitHub Pages web sites for the other repos?  What would
they contain?

And when should we use a GitHub Pages web site vs. a GitHub Wiki?

-- 
Wayne
Beaton
Director
of Open Source Projects | Eclipse
Foundation, Inc.

_______________________________________________
jakarta.ee-spec.committee mailing list
jakarta.ee-spec.committee@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe
from this list, visit
https://www.eclipse.org/mailman/listinfo/jakarta.ee-spec.committee


_______________________________________________
jakarta.ee-spec.committee mailing list
jakarta.ee-spec.committee@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe
from this list, visit
https://www.eclipse.org/mailman/listinfo/jakarta.ee-spec.committee

_______________________________________________
jakarta.ee-spec.committee mailing list
jakarta.ee-spec.committee@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe
from this list, visit
https://www.eclipse.org/mailman/listinfo/jakarta.ee-spec.committee