Skip to content

Add DR about module folder structure - #3194

Open
aschemmel-tech wants to merge 2 commits into
mainfrom
aschemmel-tech-dr-module-folder-structure
Open

aschemmel-tech wants to merge 2 commits into
mainfrom
aschemmel-tech-dr-module-folder-structure

Conversation

@aschemmel-tech

@aschemmel-tech aschemmel-tech commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

PandaeDo
PandaeDo previously approved these changes Aug 19, 2026

@masc2023 masc2023 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Get feedback from Communities, Feature Teams

@aschemmel-tech

Copy link
Copy Markdown
Contributor Author

Discussed with FT's:
Baselibs: https://github.com/orgs/eclipse-score/discussions/2390#discussioncomment-18077139 (FT is already following the proposed folder structure)
Lifecycle: https://github.com/orgs/eclipse-score/discussions/2386#discussioncomment-17825050 (FT agreed to remove /src)
Persistency: FT lead agreed to remove /src as soon as we have a decision
Other FT's not affected by change as they already follow the structure (for /src): communication, logging

4og
4og previously approved these changes Aug 20, 2026

@4og 4og left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok for baselibs

@MaciejKaszynski MaciejKaszynski left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine with lifecycle

LittleHuba
LittleHuba previously approved these changes Aug 20, 2026
AlexanderLanin
AlexanderLanin previously approved these changes Aug 20, 2026

@AlexanderLanin AlexanderLanin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fine for infrastructure work either way; some sort of alignment is always preferred for us

Context
-------

The S-CORE project defines as part of the project's processes a `module folder structure <https://eclipse-score.github.io/score/main/contribute/general/folder.html#module-folder-structure>`_.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add link and one sentence from central folder definition in S-CORE to this DR ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, will do

@aschemmel-tech
aschemmel-tech dismissed stale reviews from MaciejKaszynski, 4og, and PandaeDo via c80bc05 August 20, 2026 09:12
@aschemmel-tech
aschemmel-tech requested a review from a team as a code owner August 20, 2026 09:12
@github-actions

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-3194: https://eclipse-score.github.io/score/pr-3194/

umaucher added a commit to eclipse-score/persistency that referenced this pull request Aug 21, 2026
Removes the top-level /src and /tests folders and the cpp/rust language
split, per eclipse-score/score#3194 (module folder structure DR): the
src folder is optional and dropped, public interfaces live directly in
score/<component>/, and internal/rust_kvs/rust_kvs_tool become
lower_level_comp folders. Integration test suites move to
score/kvs/tests/ since this module has a single component.

Updates all Bazel targets, CI workflows, Cargo/pytest config, and docs
that referenced the old paths, including the coverage targets newly
introduced by #380.
@umaucher

Copy link
Copy Markdown
Contributor

fine for persistency ... realization in eclipse-score/persistency#386

# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

DR-002-Proc: Module Folder Structure

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
DR-002-Proc: Module Folder Structure
DR-003-Proc: Module Folder Structure

umaucher added a commit to eclipse-score/persistency that referenced this pull request Aug 24, 2026
Removes the top-level /src and /tests folders and the cpp/rust language
split, per eclipse-score/score#3194 (module folder structure DR): the
src folder is optional and dropped, public interfaces live directly in
score/<component>/, and internal/rust_kvs/rust_kvs_tool become
lower_level_comp folders. Integration test suites move to
score/kvs/tests/ since this module has a single component.

Updates all Bazel targets, CI workflows, Cargo/pytest config, and docs
that referenced the old paths, including the coverage targets newly
introduced by #380.
umaucher added a commit to eclipse-score/persistency that referenced this pull request Aug 24, 2026
…cture (#386)

* restructure: align module folder layout with score DR
Removes the top-level /src and /tests folders and the cpp/rust language split, per eclipse-score/score#3194 (module folder structure DR): the
src folder is optional and dropped, public interfaces live directly in score/<component>/, and internal/rust_kvs/rust_kvs_tool become
lower_level_comp folders. Integration test suites move to score/kvs/tests/ since this module has a single component.

Updates all Bazel targets, CI workflows, Cargo/pytest config, and docs that referenced the old paths, including the coverage targets newly
introduced by #380.

* ci: run same-repo PR workflows via pull_request, not stale main
pull_request_target always evaluates the workflow YAML from the base branch (main) while checking out the PR's source tree. Since this PR's
branch lives in eclipse-score/persistency itself (not a fork), the build/docs/license-check checks kept running main's stale workflow
copy against the restructured tree and failed on removed paths.

Add a same-repo pull_request trigger alongside pull_request_target, gated so same-repo PRs run untrusted-secret-free via pull_request and
fork PRs still require approval via pull_request_target.

* docs: align module documentation and generated paths
Keep module-level documentation under docs/module as required by the SCORE module folder structure, and keep KVS
component documentation and diagrams under score/kvs/docs.

Document the intentional single-component layout: component tests remain under score/kvs/tests, while the optional
component src directory is omitted so public interfaces and implementation files stay directly in score/kvs.

Update the moved documentation toctree, test README paths, and QNX image references.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog
Status: No status

Development

Successfully merging this pull request may close these issues.