diff --git a/docs/score_tools/index.rst b/docs/score_tools/index.rst index 695ccd867a..98a7af4fce 100644 --- a/docs/score_tools/index.rst +++ b/docs/score_tools/index.rst @@ -31,6 +31,7 @@ S-CORE Tools Overview score_tools_evaluation_list tools_documentation/index + tools_requirements/index tools_static_analysis_code_quality/index tools_testing_frameworks/index tools_build_development/index diff --git a/docs/score_tools/tools_requirements/index.rst b/docs/score_tools/tools_requirements/index.rst new file mode 100644 index 0000000000..a00d22300f --- /dev/null +++ b/docs/score_tools/tools_requirements/index.rst @@ -0,0 +1,91 @@ +.. + # ******************************************************************************* + # Copyright (c) 2026 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 + # ******************************************************************************* + + +Tools Requirements +================== +List of all requirements for tools of S-CORE that are not defined or adressed to specific repositories like docs-as-code. + +GitHub +^^^^^^ + +Satisfied +######### + +.. list-table:: GitHub + :header-rows: 1 + + * - ID + - Title + - Rationale + + * - gd_req__doc_author + - Document Author + - Author is stored in the PR documentation + + * - gd_req__doc_reviewer + - Document Reviewer + - All reviewers can be seen in the PR documentation + + * - gd_req__doc_approver + - Document Approver + - Approver can be seen in the PR documentation + + * - gd_req__change_attr_title + - Change Request attribute: title + - GitHub issues will be used to create change requests + + * - gd_req__problem_check_mandatory + - Problem Resolution mandatory attributes provided + - GitHub issues will be used to track problems and the mandatory attributes will be provided in the issue template + + * - gd_req__problem_attr_analysis_results + - Problem Resolution attribute: analysis results + - GitHub issues will be used to track problems and analysis results will be provided + + * - gd_req__problem_attr_classification + - Problem Resolution attribute: classification + - GitHub issues will be used to track problems and classification will be provided + + * - gd_req__problem_attr_impact_description + - Problem Resolution attribute: impact description + - GitHub issues will be used to track problems and impact description will be provided + + * - gd_req__problem_attr_milestone + - Problem Resolution attribute: milestone + - GitHub issues will be used to track problems and milestone will be provided + + * - gd_req__problem_attr_safety_affected + - Problem Resolution attribute: safety affected + - GitHub issues will be used to track problems and safety impact will be indicated + + * - gd_req__problem_attr_security_affected + - Problem Resolution attribute: security affected + - GitHub issues will be used to track problems and security impact will be indicated + + * - gd_req__problem_attr_stakeholder + - Problem Resolution attribute: stakeholder + - GitHub issues will be used to track problems and stakeholder information will be provided + + * - gd_req__problem_attr_status + - Problem Resolution attribute: status + - GitHub issues will be used to track problems and status will be maintained + + * - gd_req__problem_attr_title + - Problem Resolution attribute: title + - GitHub issues will be used to track problems and title will be provided + + * - gd_req__problem_check_closing + - Problem Resolution closing check + - GitHub issues will be used to verify all mandatory attributes before closing