Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
523ff63
Add template for v0.5 beta release
antonkri Dec 5, 2025
ea910cd
fix: handbook
FScholPer Dec 12, 2025
76db9ec
added code_of_conduct and fixed contribution guidelines
FScholPer Dec 12, 2025
dbc22bf
add process_description
masc2023 Dec 12, 2025
65be69d
release: add kyron & orchestrator notes
pawelrutkaq Dec 15, 2025
3712e83
Merge pull request #2341 from qorix-group/pawelrutkaq_rel_notes_kyron…
pawelrutkaq Dec 16, 2025
6857fe0
release: add test scenarios notes
PiotrKorkus Dec 16, 2025
4250c2e
Add release notes for EBcLfSA reference integration
opajonk Dec 17, 2025
05003ca
bump devcontainer
opajonk Dec 17, 2025
31d4a15
fixes naming
FScholPer Dec 17, 2025
9cc10ba
Merge branch 'score_v05_beta' of https://github.com/eclipse-score/sco…
FScholPer Dec 17, 2025
4739134
added descriptions
FScholPer Dec 17, 2025
01b33d9
added platform
FScholPer Dec 17, 2025
c714cc4
Update CONTRIBUTION.md
FScholPer Dec 17, 2025
a93716e
add further content
antonkri Dec 17, 2025
11957a1
updated to new
FScholPer Dec 19, 2025
d5d7eca
add_beta
FScholPer Dec 19, 2025
a028e77
add logging daemon desciption
antonkri Dec 19, 2025
fa948d1
replace maturity link for process with current status image
masc2023 Dec 19, 2025
2e49652
add baselibs release notes
antonkri Dec 19, 2025
7525bf8
further improvement
antonkri Dec 19, 2025
45254fe
Add release notes for communication
LittleHuba Dec 19, 2025
277ee7c
Update CONTRIBUTION.md
FScholPer Dec 19, 2025
908dcb8
fixed review comments
FScholPer Dec 19, 2025
1662068
Update docs/handbook/own_application/index.rst
FScholPer Dec 19, 2025
9e765ec
Update docs/handbook/own_application/index.rst
FScholPer Dec 19, 2025
80cc7b4
Update docs/score_releases/score_releases/score_v0_5_beta.rst
FScholPer Dec 19, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"name": "eclipse-s-core",
"image": "ghcr.io/eclipse-score/devcontainer:1.0.0"
"image": "ghcr.io/eclipse-score/devcontainer:v1.1.0"
}
44 changes: 35 additions & 9 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,61 @@
# Eclipse Safe Open Vehicle Core (SCORE)
# Eclipse Safe Open Vehicle Core (S-CORE)
The [Eclipse Safe Open Vehicle Core](https://projects.eclipse.org/projects/automotive.score) project aims to develop an open-source core stack for Software Defined Vehicles (SDVs), specifically targeting embedded high-performance Electronic Control Units (ECUs).
Please check the [documentation](https://eclipse-score.github.io) for more information.
Please check the [documentation](https://eclipse-score.github.io/score/main/) for more information.
The source code is hosted at [GitHub](https://github.com/eclipse-score).

The communication mainly takes place via the [`score-dev` mailing list](https://accounts.eclipse.org/mailing-list/score-dev) and GitHub issues & pull requests (PR). And we have a chatroom for community discussions here [Eclipse SCORE chatroom](https://chat.eclipse.org/#/room/#automotive.score:matrix.eclipse.org).
The communication mainly takes place via the [`score-dev` mailing list](https://accounts.eclipse.org/mailing-list/score-dev), [Discussions](https://github.com/orgs/eclipse-score/discussions) and GitHub issues & pull requests (PR).
We have a Slack channel for community discussions here [Eclipse S-CORE Slack Channel](https://sdvworkinggroup.slack.com/archives/C083Z4VL90B).

Please note that for the project the [Eclipse Foundation’s Terms of Use](https://www.eclipse.org/legal/terms-of-use/) apply.
In addition, you need to sign the [ECA](https://www.eclipse.org/legal/ECA.php) and the [DCO](https://www.eclipse.org/legal/dco/) to contribute to the project.

## Contributing

### Code of Conduct

Please be familiar with the [Code of Conduct](CODE_OF_CONDUCT.md).

## Eclipse Contributor Agreement & Developer Certificate of Origin

Please note that for the project the [Eclipse Foundation’s Terms of Use](https://www.eclipse.org/legal/terms-of-use/) apply.

Before your contribution can be accepted by the project team contributors must
electronically sign the Eclipse Contributor Agreement (ECA).

* https://www.eclipse.org/legal/eca/


For more information, please see the Eclipse Committer Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit

To complete and submit a ECA, log into the
[Eclipse projects forge](https://www.eclipse.org/contribute/cla/)
(you will need to create an account with the Eclipse Foundation if you have not already done so).
Click on "Eclipse Contributor Agreement" and complete the form.
Be sure to use the same email address when you register for the account
that you intend to use when you commit to Git.

In addition, you need to sign the [DCO](https://www.eclipse.org/legal/dco/) to contribute to the project.


### Getting the source code & building the project
Please refer to the [README.md](README.md) for further information.

### Getting involved

#### Setup Phase
This phase is part of the eclipse Incubation Phase and shall establish all the processes needed for a safe development of functions. Only after this phase it will be possible to contribute code to the project. As the development in this project is driven by requirements, the processes and needed infrastructure incl. tooling will be established based on non-functional Stakeholder_Requirements<!-- TODO: fill link to correct page with requirements -->. During setup phase the contributions are Bug Fixes and Improvements (both on processes and infrastructure).
This phase is part of the eclipse Incubation Phase and shall establish all the processes needed for a safe development of functions. Only after this phase it will be possible to contribute code to the project. As the development in this project is driven by requirements, the processes and needed infrastructure incl. tooling will be established based on [Non-functional Stakeholder_Requirements](https://eclipse-score.github.io/score/main/requirements/stakeholder/index.html). During setup phase the contributions are Bug Fixes and Improvements (both on processes and infrastructure).

#### Bug Fixes and Improvements
Improvements are adding/changing processes and infrastructure, bug fixes can be also on development work products like code.
In case you want to fix a bug or contribute an improvement, please perform the following steps:
1) Create a PR by using the corresponding template ([Bugfix PR template](.github/PULL_REQUEST_TEMPLATE/bug_fix.md) or [Improvement PR template](.github/PULL_REQUEST_TEMPLATE/improvement.md)). Please mark your PR as draft until it's ready for review by the Committers (see the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#contributing-committers) for more information on the role definitions). Improvements are requested by the definition or modification of [Stakeholder Requirements](docs/stakeholder_requirements) or [Tool Requirements](docs/tool_requirements) and may be implemented after acceptance/merge of the request by a second Improvement PR. The needed reviews are automatically triggered via the [CODEOWNERS](.github/CODEOWNERS) file in the repository.
2) Initiate content review by opening a corresponding issue for the PR when it is ready for review. Review of the PR and final merge into the project repository is in responsibility of the Committers. Use the [Bugfix Issue template](.github/ISSUE_TEMPLATE/bug_fix.md) or [Improvement Issue template](.github/ISSUE_TEMPLATE/improvement.md) for this.

Please check here for our Git Commit Rules in the [Configuration_Tool_Guidelines](https://eclipse-score.github.io/score/process_description/guidelines/index.html).
Please check here for our Git Commit Rules in the [Git Guidelines](https://eclipse-score.github.io/score/main/contribute/general/git.html).

Please use the [Stakeholder and Tool Requirements Template](https://eclipse-score.github.io/score/process_description/templates/index.html) when defining these requirements.

![Contribution guide workflow](./docs/_assets/contribution_guide.svg "Contribution guide workflow")

#### Additional Information
Please note, that all Git commit messages must adhere the rules described in the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#resources-commit).

Please find process descriptions here: [process description](https://eclipse-score.github.io/score/process_description/).
Please find process descriptions here: [process description](https://eclipse-score.github.io/process_description/main/index.html).
2 changes: 1 addition & 1 deletion docs/features/baselibs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

.. _baselibs_feature:

Base Libraries (v0.5 alpha)
Base Libraries (v0.5 beta)
###########################

.. document:: Base Libraries
Expand Down
2 changes: 1 addition & 1 deletion docs/features/communication/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

.. _com_feature:

Communication (v0.5 alpha)
Communication (v0.5 beta)
##########################

.. document:: Communication
Expand Down
4 changes: 2 additions & 2 deletions docs/features/frameworks/feo/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Fixed execution order framework (FEO)
#####################################
Fixed execution order framework (FEO) (v0.5 beta)
#################################################

.. document:: Fixed execution order framework
:id: doc__frameworks_feo
Expand Down
2 changes: 1 addition & 1 deletion docs/features/orchestration/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

.. _orch_feature:

Orchestration (v0.5 alpha)
Orchestration (v0.5 beta)
##########################

.. document:: Orchestration
Expand Down
2 changes: 1 addition & 1 deletion docs/features/persistency/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Persistency (v0.5 alpha)
Persistency (v0.5 beta)
########################

.. toctree::
Expand Down
33 changes: 21 additions & 12 deletions docs/handbook/own_application/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To integrate the communication module into your project, follow these steps:
1. Setup
-----------

Start by creating a new project in your preferred IDE (e.g., Visual Studio Code). A ready-to-use devcontainer is available under:
Start by creating a new project in your preferred IDE (e.g., Visual Studio Code). A ready-to-use devcontainer is available under:

- https://github.com/eclipse-score/devcontainer

Expand All @@ -54,7 +54,7 @@ Reference documentation for the communication module:

module(name = "use_com_test")

bazel_dep(name = "score_toolchains_gcc", version = "0.4", dev_dependency=True)
bazel_dep(name = "score_toolchains_gcc", version = "0.5", dev_dependency=True)

gcc = use_extension("@score_toolchains_gcc//extensions:gcc.bzl", "gcc", dev_dependency=True)
gcc.toolchain(
Expand Down Expand Up @@ -84,8 +84,16 @@ Reference documentation for the communication module:
)

bazel_dep(name = "boost.program_options", version = "1.87.0")
bazel_dep(name = "score-baselibs", version = "0.1.3")
bazel_dep(name = "communication", version = "0.1.1")
bazel_dep(name = "score_baselibs", version = "0.1.3")
bazel_dep(name = "score_communication", version = "0.1.1")

# TRLC dependency for requirements traceability
bazel_dep(name = "trlc", version = "0.0.0")
git_override(
module_name = "trlc",
commit = "ede35c4411d41abe42b8f19e78f8989ff79ad3d8",
remote = "https://github.com/bmw-software-engineering/trlc.git",
)

Be aware that the version numbers change over time. Always check the latest versions in the respective bazel registry

Expand All @@ -108,15 +116,16 @@ Be aware that the version numbers change over time. Always check the latest vers
common --@score-baselibs//score/json:base_library=nlohmann
common --@communication//score/mw/com/flags:tracing_library=stub

common --registry=https://raw.githubusercontent.com/eclipse-score/bazel_registry/refs/heads/main/
common --registry=https://raw.githubusercontent.com/eclipse-score/bazel_registry/v0.5.0-beta/

common --registry=https://bcr.bazel.build

^^^^^^^^^^^^^
1.3 Run Bazel
^^^^^^^^^^^^^

If you start with an empty project, add an empty file named ``BUILD`` into your project root.
Now you can now run build the project with the command bazel ``bazel build //...``
Now you can now run build the project with the command bazel ``bazel build //...``

(At this point nothing happens yet, because no targets are defined).
You can now either continue with this guide to create a minimal consumer-producer example or start coding your own application
Expand All @@ -133,9 +142,9 @@ Once your project is set up, you can start sending and receiving messages.
^^^^^^^^^^^^^^^^^^^^

Create a folder named ``src`` in your root project directory.
Inside ``src``, create the following folders:
Inside ``src``, create the following folders:

- ``consumer``
- ``consumer``
- ``producer``

additional folders if needed.
Expand Down Expand Up @@ -278,11 +287,11 @@ After that, create the file ``producer.cpp``.

The constructor initializes the communication skeleton ``create_result``.

``RunProducer``:
``RunProducer``:

- checks if the initialization of ``create_result`` was successful
- offers service
- enters a loop and sends our messages
- offers service
- enters a loop and sends our messages
- stops offering the service at the end


Expand All @@ -298,4 +307,4 @@ Navigate to the ``consumer`` directory and create a new file called ``consumer.h
^^^^^^^^^^^^^^
For a complete example implementation, see the example folder

https://github.com/eclipse-score/communication/tree/main/score/mw/com/example/ipc_bridge
https://github.com/eclipse-score/communication/tree/main/score/mw/com/example/ipc_bridge
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 17 additions & 1 deletion docs/score_releases/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,23 @@ See also the project life cycle within the `Eclipse Development Process <https:/
S-CORE Releases Overview
========================

Timeline
---------
The current timeline for Eclipse S-CORE releases is shown below.

.. image:: ./_assets/score_release_plan.drawio.svg
:width: 800
:alt: Architecture overview
:align: center

|

For a detailed and always up-to-date planning view, see the `GitHub project <https://github.com/orgs/eclipse-score/projects/17/views/26>`_.

List of S-CORE released versions
---------------------------------

.. toctree::
:maxdepth: 1
:maxdepth: 2

score_releases/index.rst
1 change: 1 addition & 0 deletions docs/score_releases/score_releases/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ S-CORE Releases
:maxdepth: 1

score_v0_5_alpha.rst
score_v0_5_beta.rst
15 changes: 1 addition & 14 deletions docs/score_releases/score_releases/score_v0_5_alpha.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ S-Core v0.5-alpha release notes

.. document:: S-Core v0.5-alpha release note
:id: doc__score_v05_alpha_release_note
:status: draft
:status: valid
:safety: ASIL_B
:security: YES
:realizes: wp__platform_sw_release_note
Expand Down Expand Up @@ -52,19 +52,6 @@ Highlights
- Initial set of communication, persistency, orchestration, and base utility modules.
- Experimental reference images for QNX, Red Hat AutoSD Linux, and EB corbos Linux for Safety Applications.

Timeline
---------
The current timeline for Eclipse S-CORE releases is shown below.

.. image:: ../_assets/score_release_plan.drawio.svg
:width: 800
:alt: Architecture overview
:align: center

|

For a detailed and always up-to-date planning view, see the `GitHub project <https://github.com/orgs/eclipse-score/projects/17/views/26>`_.

Eclipse S-CORE book
-------------------
The first version of the `Eclipse S-CORE book <https://eclipse-score.github.io/score/main/handbook/index.html>`_
Expand Down
Loading