Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [jakarta.ee-spec.committee] GitHub repository naming conventions?
I started typing this before Bill's response. I think that I'm mostly repeating what he's said...

I see hints of confusion regarding the difference between a project and a Git repository popping up in conversations here-and-there... 

"Project" is a super overloaded term. I completely understand that the community is going to call things what they want to call things and fighting that is futile. But I want to at least make sure that everybody on this list are on the same page regarding how the Eclipse Development Process sees projects and everything that follows from that.

"Project" has specific meaning in the Eclipse Development Process and "Specification Project" has specific meaning in the Eclipse Foundation Specification Process (which is based on the definition of "Project" in the EDP).

A Project is the main operational unit for open source development at the Eclipse Foundation. A Project has a single team of committers, one or more project leads, and a collection of shared resources on which every member of the committer team has uniform access.

Git repositories are one of the resources allocated to a project team. Every member of the project team (i.e., every committer on a project) has the same write access on all project resources as every other member of the team. In practical terms, we set up and manage a single GitHub Team for each Eclipse Project committer team and assign all GitHub repositories associated with the Eclipse Project to that GitHub Team. We do not configure teams at the repository level. 

If a hypothetical single Eclipse Project (or Specification Project) has "*-api" and "*-spec" GitHub repositories, then every committer on that Eclipse Project will be able to push to and accept pull requests for both of those repositories.

So... by keeping the repositories separate, it would be easier to manage (by convention within the team) which team members should or should not be working in a particular repository. The separation would not prevent a committer from dabbling where they should not, but the clear separation would at least help them understand where the lines are drawn (and maybe make it easier for other committers to notice when they cross the line). FWIW, a lot of Eclipse projects get along very well with this sort of practice.

Another consideration... we might want to keep the spec and API separate to make it easier to maybe split an existing single project into separate Specification and API projects at some point later. Any such split, however, is not on our current plan, and I very strongly recommend that we don't try to add this to the critical path for Jararta EE 8.

Note that we can split repositories and projects at a later date if circumstances dictate that doing so makes sense.

Wayne

On Thu, Jun 20, 2019 at 10:22 AM Richard Monson-Haefel <rmonson@xxxxxxxxxxxxx> wrote:
I think its best to separate API, Spec, and TCK.  Different people will be working on these. For example, Joe from ABC corp might be working on the spec, but its Jill from ABC Corp who is doing the API adjustments/creation and Wanda from ABC Corp doing the TCK.  We don't want JIll or Wanda on the Spec project.  that's Joe's job.

On Wed, Jun 19, 2019 at 2:10 PM Kevin Sutter <sutter@xxxxxxxxxx> wrote:
That is my understanding as well, Bill.  I thought the long term goal was to have the TCKs in separate projects, but we were not going to enforce that at this time.


---------------------------------------------------
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:        Scott Stark <sstark@xxxxxxxxxx>
Cc:        Jakarta specification committee <jakarta.ee-spec.committee@xxxxxxxxxxx>
Date:        06/19/2019 12:11 PM
Subject:        [EXTERNAL] Re: [jakarta.ee-spec.committee] GitHub repository naming        conventions?
Sent by:        jakarta.ee-spec.committee-bounces@xxxxxxxxxxx



My understanding is that that would require them to be separate Eclipse projects, which is not the current plan.

Yes, if someone wanted to be a Committer on a TCK without their IP being contributed to the corresponding spec, we would need them to be separate projects.


Scott Stark wrote on 6/19/19 9:28 AM:
That should not be necessary in terms of IP capture. The TCK is an implementation of a testing framework for the spec, not a specification document that expands the IP commitments. We should be able to have committers to a TCK that are not committers to a spec.


On Jun 19, 2019, at 8:59 AM, Bill Shannon <bill.shannon@xxxxxxxxxx> wrote:

Since they're all part of the same Eclipse project, they all share the same set of committers.

Scott Stark wrote on 6/19/19 7:33 AM:
We have found that a convenient organization in our projects as it best matches the committer issues. The TCK should have a wider committer list than the specs/apis.

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

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




_______________________________________________
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


--

Wayne Beaton

Director of Open Source Projects | Eclipse Foundation, Inc.

Back to the top