Skip to content

Add attributes to decision record template #778

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.

Sign up for GitHub

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

Merged
masc2023 merged 1 commit into from
Aug 20, 2026
Merged

Add attributes to decision record template #778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions process/folder_templates/platform/docs/change/decision_record.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,20 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

.. _decision_record_template:
.. _decision_record_template_instance:

Decision Record Template
========================

.. document:: [Number] Decision Record
:id: doc__number_decision_record_template
:status: draft
:version: 3
:safety: ASIL_B
:security: YES
:realizes: wp__feat_request
:tags: template

This template is used to create new Decision Records (DRs) in the project using rst files.
For markdown files, please convert the sphinx directive to markdown syntax yourself.
The content of the DR is the same, only the syntax differs.
Expand All @@ -31,9 +40,12 @@ In each DR file, include the following sections:
.. dec_rec:: <Title>
:id: dec_rec__<Platform|Feature|Component>__<Title>, dec_rec__<arch|proc|strat|infra|int>__<slug>
:status: <proposed|accepted|deprecated|rejected|superseded>
:context: <what kind of problem does it address>
:decision: <state the decision which alternative is selected>
:tracking: <link to GitHub issue URL, required once a DR is confirmed>
:version: 2
:affects: <link>
:version: <version of the decision record>
:affects: <link to work products>
:consequences: <impact of this change>

<Description>
Descriptions shall contain at least the following sections:
Expand Down
2 changes: 1 addition & 1 deletion ...areas/change_management/guidance/change_management_decision_record_template.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Decision Record Template
:version: 2
:complies: std_req__aspice_40__SWE-2-BP3[version==1], std_req__aspice_40__iic-17-00[version==1]

For the content see here: :ref:`decision_record_template`.
For the content see here: :ref:`decision_record_template_instance`.

.. needextend:: "c.this_doc()"
:+tags: change_management
Loading