-
Notifications
You must be signed in to change notification settings - Fork 102
docs: add DR-002-strat for Eclipse project structure decision #2926
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
antonkri
wants to merge
2
commits into
main
Choose a base branch
from
ankr_add_dr_for_proj_structure
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| .. | ||
| Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
|
|
||
| See the NOTICE file(s) distributed with this work for additional | ||
| information regarding copyright ownership. | ||
|
|
||
| This program and the accompanying materials are made available under the | ||
| terms of the Apache License Version 2.0 which is available at | ||
| https://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| DR-002-Strat: Eclipse Project Structure for S-Core | ||
| =================================================== | ||
|
|
||
| - **Date:** 2026-05-22 | ||
|
|
||
| .. dec_rec:: Eclipse Project Structure for S-Core | ||
| :id: dec_rec__strat__eclipse_project_structure | ||
| :status: accepted | ||
| :context: Strategy | ||
| :decision: Option 1 | ||
|
|
||
| Context / Problem | ||
| ----------------- | ||
|
|
||
| The strategic decision to treat S-Core as a platform rather than a collection of independent | ||
| modules was already taken in DR-001-Strat. This decision record focuses solely on the technical | ||
| question of how to structure the S-Core project within the Eclipse Foundation and GitHub. | ||
|
|
||
| Two organisational models are under consideration: keeping all modules within one Eclipse project | ||
| (the current approach), or splitting each module into a separate Eclipse project. | ||
|
|
||
| The choice has implications for community governance, Committer nomination processes, GitHub | ||
| organisation management, and the long-term risk to the S-Core v1.0 release. | ||
|
|
||
| Options Considered | ||
| ------------------ | ||
|
|
||
| Option 1: One Eclipse Project (currently used) | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| All S-Core relevant modules reside together in one GitHub organisation under one Eclipse project. | ||
|
|
||
| .. uml:: | ||
| :align: center | ||
| :caption: Option 1 – One Eclipse project containing all S-Core repositories | ||
|
|
||
| skinparam componentStyle rectangle | ||
|
|
||
| component "eclipse" as ef <<Eclipse Foundation>> { | ||
| component "eclipse-score" as org <<GitHub Organisation>> { | ||
| component "score" as score | ||
| component "feo" as feo | ||
| component "baselibs" as baselibs | ||
| component "logging" as logging | ||
| component "persistence" as persistence | ||
| component "process_description" as proc | ||
| component "docs-as-code" as dac | ||
| } | ||
| } | ||
|
|
||
| score -[hidden]right- feo | ||
| feo -[hidden]right- baselibs | ||
| baselibs -[hidden]right- logging | ||
| score -[hidden]down- persistence | ||
| persistence -[hidden]right- proc | ||
| proc -[hidden]right- dac | ||
|
|
||
| **Pros** | ||
|
|
||
| - All S-Core relevant modules are together in one GitHub organisation → it is immediately visible | ||
| what belongs to the S-Core project. | ||
| - One infrastructure, one timeline, one community → things are kept together. | ||
| - One authority (PLs) for all modules that can ensure the same behaviour for all modules. | ||
|
|
||
| **Cons** | ||
|
|
||
| - Eclipse Foundation project handbook rules were not designed for such big projects. This leads | ||
| among others to the following problems: | ||
|
|
||
| - It is typically not possible to nominate initial Committers for newly contributed modules. | ||
| - The Committer model does not completely scale for such big projects. Having a large number of | ||
| modules in one Eclipse project leads to the necessity of having a big number of Committers | ||
| with various areas of responsibility. | ||
|
|
||
| **Possible mitigation** | ||
|
|
||
| - Eclipse Foundation and PMC must acknowledge and agree that new modules in S-Core are treated | ||
| as new Eclipse projects for the purpose of initial Committer nomination. | ||
| - Mapping/restricting of Committer responsibilities in the project to dedicated areas is done | ||
| using the CODEOWNERS file in GitHub (already in place). | ||
|
|
||
| Option 2: Multiple Eclipse Projects | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| Every module becomes its own Eclipse project; a central S-Core project serves as the integration | ||
| project. | ||
|
|
||
| .. uml:: | ||
| :align: center | ||
| :caption: Option 2 – Multiple Eclipse projects, S-Core as the central integration project | ||
|
|
||
| top to bottom direction | ||
| skinparam componentStyle rectangle | ||
|
|
||
| component "eclipse (parent)" as ef_parent <<Eclipse Foundation>> { | ||
| component "eclipse-score / score\n(integration project)" as score_central | ||
| } | ||
|
|
||
| component "eclipse A" as ef_a <<Eclipse Foundation>> { | ||
| component "... / baselibs" as baselibs | ||
| } | ||
|
|
||
| component "eclipse B" as ef_b <<Eclipse Foundation>> { | ||
| component "... / logging" as logging | ||
| } | ||
|
|
||
| component "eclipse ..." as ef_n <<Eclipse Foundation>> { | ||
| component "..." as more | ||
| } | ||
|
|
||
| score_central <.. baselibs : sub-project | ||
| score_central <.. logging : sub-project | ||
| score_central <.. more : sub-project | ||
|
|
||
| **Pros** | ||
|
|
||
| - Every module is a "small" Eclipse project, which is exactly what the Eclipse Foundation project | ||
| handbook is built for → Clear Committer/Contributor/PL management. | ||
|
|
||
| **Cons** | ||
|
|
||
| - Every project is a completely standalone project. The S-Core project PLs do not have tools to | ||
| manage the separate Eclipse projects with implementation modules, which creates a significant | ||
| risk that the S-Core community could fracture. | ||
| - Every module/project has its own GitHub Organisation → enforcing the same rules and processes | ||
| is complicated; belonging to S-Core project is not obvious. | ||
|
|
||
| **Possible mitigation** | ||
|
|
||
| - Currently no possible mitigations known for Cons 1. | ||
| - The Eclipse Foundation technically enables S-Core and all sub-projects/modules to be located | ||
| within the same GitHub organisation. | ||
|
|
||
| Conclusion | ||
| ---------- | ||
|
|
||
| **We proceed with Option 1** | ||
|
|
||
| Rationale | ||
| ^^^^^^^^^ | ||
|
|
||
| - There are currently no major blockers that would make the switch to Option 2 obligatory. | ||
| - Switching the structure of the project and module repositories poses a high risk for the | ||
| S-Core v1.0 release, which is planned for the end of the year. | ||
|
|
||
| Follow-up Actions | ||
| ^^^^^^^^^^^^^^^^^ | ||
|
|
||
| - **X-Core approaches Eclipse Foundation**: Eclipse Foundation and PMC must acknowledge and agree | ||
| that new modules in S-Core are treated as new Eclipse projects for the purpose of initial | ||
| Committer nomination. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should first wait until the PMC approves. If I would vote the probability is not too high