..
   # *******************************************************************************
   # Copyright (c) 2025 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
   # *******************************************************************************

Release Note
============

.. note:: Document header

.. document:: [Your Module Name] Release Note
   :id: doc__module_name_release_note
   :status: draft
   :safety: ASIL_B
   :security: NO
   :realizes: wp__module_sw_release_note
   :tags: template

.. attention::
    The above directive must be updated according to your Module.

    - Modify ``Your Module Name`` to be your Module Name
    - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc_`` and succeeded by ``release_note``
    - Adjust ``status`` to be ``valid``
    - Adjust ``safety`` and ``tags`` according to your needs



| Module Name: [Module Name]
| Release Tag: vX.Y.Z
| Origin Release Tag: vU.V.W
| Release Commit Hash: a1b2c3d4e5f6g7h8i9j0
| Release Date: YYYY-MM-DD
| Safety: [QM | ASIL_B]
| Security: [NO | YES]
|
| Overview
| --------
|
| This document provides an overview of the changes, improvements, and bug fixes included in the software module release version vX.Y.Z
|  as compared to the module's origin release (which is usually the previous release).
|
|  Disclaimer
|  ----------
|  This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment.
|  The work products compiled in the safety package are created with care according to a process satisfying standards, but the as the project,
|  being a non-profit and open source organization, can not take over any liability for its content.
|
| New Features
| ------------
|
| - **Feature 1**: Brief description of the new feature.
| - **Feature 2**: Brief description of the new feature.
| - **Feature 3**: Brief description of the new feature.
|
| Improvements
| ------------
|
| - **Improvement 1**: Brief description of the improvement.
| - **Improvement 2**: Brief description of the improvement.
| - **Improvement 3**: Brief description of the improvement.
|
| Bug Fixes
| ---------
|
| - **Bug 1**: Brief description of the bug fix.
| - **Bug 2**: Brief description of the bug fix.
| - **Bug 3**: Brief description of the bug fix.
|
| Other changes by Label
| ----------------------
|
| - **Label 1/Refactor 1**: Brief description of the change.
| - **Label 2/Refactor 2**: Brief description of the change.
| - **Label 3/Refactor 3**: Brief description of the change.
|
| Compatibility
| -------------
|
| - **Dependencies**: List any dependencies and their versions.
|
|  Performed Verification
|  ----------------------
|  This release note is based on the verification as documented in module verification report
|  :need:`doc__module_name_verification_report`.
|
| Known Issues
| ------------
|
| - **Issue 1**: Brief description of the known issue. Justification regarding safety impact.
| - **Issue 2**: Brief description of the known issue. Justification regarding safety impact.
| - **Issue 3**: Brief description of the known issue. Justification regarding safety impact.
|
| Known Vulnerabilities
| ---------------------
|
| - **CVE 1**: Brief description of the known CVE. Justification regarding security impact.
| - **CVE 2**: Brief description of the known CVE. Justification regarding security impact.
| - **CVE 3**: Brief description of the known CVE. Justification regarding security impact.
|
| Upgrade Instructions
| --------------------
|
| 1. **Step 1**: Description of the first step.
| 2. **Step 2**: Description of the second step.
| 3. **Step 3**: Description of the third step.
|
| Contributors
| ------------
|
| Thanks to everyone who contributed to this release:
|
| Contributor 1
| Contributor 2
|

---

| Contact Information
| -------------------
|
| For any questions or support, please contact the *Project lead* or raise an issue/discussion.