Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bugfix.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# *******************************************************************************
# 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
# *******************************************************************************

name: Problem Report
description: Issue to track a bug
title: "Bug: Your bugfix title"
labels: ["codeowner_review"]
body:
- type: markdown
attributes:
value: "## <ins>Bug Ticket creation</ins>"
- type: textarea
attributes:
label: Description
description: Short Description of the Bug
validations:
required: true
- type: dropdown
attributes:
label: Error Occurrence Rate
options:
- Single Event
- Sporadic
- Highly Intermittent
- Reproducible
- type: textarea
attributes:
label: How to reproduce
description: How to reproduce?
- type: textarea
attributes:
label: Supporting Information
description: |
During which operational state did the issue occur
Observations / Screenshots / Traces
validations:
required: false
- type: dropdown
attributes:
label: Classification
options:
- minor
- major
- critical
- blocker
default: 0
validations:
required: true
- type: dropdown
attributes:
label: Affected Version
options:
- 0.5
- 1.0
default: 0
validations:
required: true
- type: dropdown
attributes:
label: Expected Closure Version
options:
- 0.5
- 1.0
default: 0
validations:
required: false
- type: checkboxes
attributes:
label: Category
options:
- label: Safety Related
- label: Security Related
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/2-improvement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# *******************************************************************************
# 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
# *******************************************************************************

name: "Improvement / Task"
description: Issue to track a improvement / task
title: "Improvement: Your Improvement title"
labels: ["codeowner_review"]
body:
- type: textarea
attributes:
label: What
description: |
- Goal of the Improvement / Task
- If Req/Architecture is affected, the template of
[Change Management](https://eclipse-score.github.io/process_description/main/process_areas/change_management/guidance/change_management_impact_analysis_template.html) needs to be used
validations:
required: true
- type: textarea
attributes:
label: How
description: Details on implementation approach
validations:
required: false
- type: textarea
attributes:
label: Estimates for realization
description: |
- Estimate the effort, resources, risk for the realization
- Impact to users of the feature
validations:
required: true
- type: checkboxes
attributes:
label: Category
options:
- label: Affects Detailed Design
- type: checkboxes
attributes:
label: Requirements / Architecture
options:
- label: Requirements / Architecture are not affected by this change?
required: true
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# *******************************************************************************
# 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
# *******************************************************************************

blank_issues_enabled: false
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Workflow Platform Management
:approved_by: rl__process_community
:supported_by: rl__safety_manager, rl__security_manager, rl__quality_manager
:input: wp__policies, wp__issue_track_system
:output: wp__platform_mgmt, wp__project_mgt, wp__document_mgt_plan, wp__config_mgt_plan
:output: wp__platform_mgmt, wp__project_mgt, wp__document_mgt_plan, wp__config_mgt_plan, wp__prm_plan
:contains: gd_temp__platform__mgmt_plan, gd_guidl__platform__mgmt_plan, gd_guidl__documentation, gd_chklst__documentation__review, gd_temp__documentation
:has: doc_concept__platform__process, doc_getstrt__platform__process

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,5 @@ Problem Checklist
-

* - 13
- If the Problem report is not closed and pending solution measures are open, escalated to the :need:`rl__safety_manager`?
- If the Problem report is not closed and pending solution measures are open, escalated to the :need:`rl__safety_manager` or :need:`rl__security_manager`?
-
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,13 @@ This document describes the general guidances for Problem Resolution based on th
General Hints
=============

The detailed implementation of the Problem Resolution for **S-CORE** is described in the `[[title]]<REPLACE_doc__platform_problem_resolution_plan>`.
The detailed implementation of the Problem Resolution for the project shall be described in the :ref:`Workflow Platform Management <workflow_platform_management>`.

Templates
---------

To create problem reports, **S-CORE** provides the following template: :need:`[[title]]<gd_temp__problem__template>`.
To create problem reports, the project shall provide the following template: :need:`[[title]]<gd_temp__problem__template>`.
An example template for the issue trackings system GitHub can be found here: (to be updated later)

Attributes
----------
Expand All @@ -52,31 +53,32 @@ A more detailed description can be found here: :ref:`prm_process_requirements`
Activities for Problem Resolution
=================================

This section describes in detail which steps need to be performed for a Problem resolution.

Refer to the `Problem Resolution Plan <REPLACE_doc__platform_problem_resolution_plan>` for examples
how to create problem reports.
This section describes in detail which steps need to be performed for a Problem Resolution.

.. list-table:: Activities for Problem Resolution
:header-rows: 1
:widths: 10,60,30
:widths: 10,60,30,30

* - Step
- Description
- Responsible
- Approver
* - :ref:`1. <prm_create_problem_report>`
- Create Problem Report
- :need:`[[title]] <rl__contributor>`
- :need:`[[title]] <rl__committer>`
* - :ref:`2. <prm_analyze_problem_report>`
- Analyse Problem Report
- Analyze Problem Report
- :need:`[[title]] <rl__contributor>`
- :need:`[[title]] <rl__committer>`
* - :ref:`3. <prm_initiate_problem_resolution>`
- Initiate and Monitor Problem Resolution
- :need:`[[title]] <rl__contributor>`
- :need:`[[title]] <rl__committer>`
* - :ref:`4. <prm_monitor_problem_resolution>`
- Close Problem Resolution
- :need:`[[title]] <rl__committer>`

- :need:`[[title]] <rl__technical_lead>`, :need:`[[title]] <rl__module_lead>`

.. _prm_create_problem_report:

Expand All @@ -94,18 +96,18 @@ The description should reflect the problem root cause and impact in detail.
Copy therefore the :need:`Problem Template <gd_temp__problem__template>` into the created Problem
Report (Issue Tracking System).

Set the status of the Problem to "open", when ready to review and analyse set to "in review".
Set the status of the Problem to "open", when ready to review and analyze set to "in review".

.. _prm_analyze_problem_report:

Analyse Problem Report
Analyze Problem Report
----------------------

The **S-CORE** :need:`[[title]] <rl__committer>` analyzes the problem together with the
The projects :need:`[[title]] <rl__committer>` analyzes the problem together with the
:need:`[[title]] <rl__contributor>` and takes a decision for accepting or rejecting it.

If accepted, the status is set to "in implementation" and :need:`[[title]] <rl__contributor>`
can start with the iniation of the Problem Resolution, otherwise the status is set to "rejected".
can start with the initiation of the Problem Resolution, otherwise the status is set to "rejected".

The author has the freedom to cancel it at any time by setting the status to "rejected".

Expand All @@ -119,7 +121,7 @@ Initiate and Monitor Problem Resolution
Therefore further activities needs to be planned and linked to the Problem Report.

During the resolution the responsible lead :need:`[[title]] <rl__technical_lead>` or
:need:`[[title]] <rl__module_lead>` reports regularly the status to the affected **S-CORE** teams.
:need:`[[title]] <rl__module_lead>` reports regularly the status to the affected projects teams.

The author has the freedom to cancel it at any time by setting the status to "rejected".

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Problem Attributes
:id: gd_req__problem__attr_uid
:status: valid
:tags: done_automation, problem_resolution, attribute, mandatory
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP1

Each Problem shall have a unique ID. It shall be in an integer number.
Expand All @@ -35,7 +35,7 @@ Problem Attributes
:id: gd_req__problem__attr_status
:status: valid
:tags: manual, problem_resolution, attribute, mandatory
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP1

Each Problem shall have a status:
Expand All @@ -50,7 +50,7 @@ Problem Attributes
:id: gd_req__problem__attr_title
:status: valid
:tags: manual, problem_resolution, attribute, mandatory
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP1

Reason for Problem Report
Expand All @@ -59,21 +59,21 @@ Problem Attributes
:id: gd_req__problem__attr_impact_description
:status: valid
:tags: manual, problem_resolution, attribute, mandatory
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP1, std_req__aspice_40__SUP-9-BP2

Exact description of the Problem, including potential cause and impact of the problem.

Record especially, if functional safety or cybersecurity may affected here.

Record potential affected parties, and if it may requried to notify them about the potential
Record potential affected parties, and if it may required to notify them about the potential
problem.

.. gd_req:: Problem attribute: analysis results
:id: gd_req__problem__attr_anaylsis_results
:status: valid
:tags: manual, problem_resolution, attribute, mandatory
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP2

Record analysis results (e.g. reason for rejection, safety, security, quality impact) as comments.
Expand All @@ -82,17 +82,17 @@ Problem Attributes
:id: gd_req__problem__attr_stakeholder
:status: valid
:tags: prio_1_automation, problem_resolution, attribute, mandatory
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP2, std_req__aspice_40__SUP-9-BP5

Assign responsible stakeholder for analysing the problem
Assign responsible stakeholder for analyzing the problem
Assign responsible stakeholder to resolve the problem

.. gd_req:: Problem attribute: classification
:id: gd_req__problem__attr_classification
:status: valid
:tags: prio_1_automation, problem_resolution, attribute, mandatory
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP1, std_req__aspice_40__SUP-9-BP2

Each Problem shall have a classification identifier:
Expand All @@ -102,23 +102,11 @@ Problem Attributes
* critical
* blocker

.. gd_req:: Problem attribute: category
:id: gd_req__problem__attr_category
:status: valid
:tags: prio_3_automation, problem_resolution, attribute, mandatory
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP1

Each Problem shall have a category identifier:

* User
* Bug

.. gd_req:: Problem attribute:: safety affected
:id: gd_req__problem__attr_safety_affected
:status: valid
:tags: prio_1_automation, problem_resolution, attribute, mandatory
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP1

Each Problem shall have a safety relevance identifier:
Expand All @@ -132,7 +120,7 @@ Problem Attributes
:id: gd_req__problem__attr_security_affected
:status: valid
:tags: prio_1_automation, problem_resolution, attribute, mandatory
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP1

Each Problem shall have a security relevance identifier:
Expand All @@ -146,7 +134,7 @@ Problem Attributes
:id: gd_req__problem__attr_milestone
:status: valid
:tags: manual, problem_resolution, attribute, mandatory
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP1, std_req__aspice_40__SUP-9-BP6

Milestone until the Problem must be implemented (used for prioritization)
Expand All @@ -159,7 +147,7 @@ Problem Resolution Checks
:id: gd_req__problem__check_mandatory
:status: valid
:tags: prio_2_automation, problem_resolution, attribute, check
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP1

It shall be checked if all mandatory attributes for each Problem
Expand All @@ -175,7 +163,7 @@ Problem Resolution Checks
:id: gd_req__problem__check_closing
:status: valid
:tags: prio_1_automation, problem_resolution, attribute, check
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
:complies: std_req__aspice_40__SUP-9-BP1

ISSUEs related to Problem Reports shall not automatically closed, if linked ISSUEs or PRs are closed or merged and
Expand Down
Loading