From 71808afb38202c359289a435b308bca800ddacd1 Mon Sep 17 00:00:00 2001 From: "Robert C. Seacord" Date: Wed, 3 Dec 2025 03:37:49 -0500 Subject: [PATCH 1/2] Update conf.py add some new tags and update the descriptions of some existing tags --- src/conf.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/conf.py b/src/conf.py index dd179da7f..9a2aee0a2 100644 --- a/src/conf.py +++ b/src/conf.py @@ -101,17 +101,21 @@ needs_tags = [ dict(name="security", description="Security-related guideline"), + dict(name="safety", description="The degree to which a product or system avoids endangering human life, health, property, or the environment under defined operating conditions."), dict(name="performance", description="Performance-related guideline"), dict(name="readability", description="Readability-related guideline"), + dict(name="understandability", description="Understandability is a sub-characteristic of usability in the ISO/IEC 25000 quality model, which measures how easy it is for users to understand the functions and usage of a software product. It is also a separate quality characteristic for data, referring to how well data can be read and interpreted by users with the help of appropriate languages, symbols, and units. +"), dict(name="reduce-human-error", description="Guideline that helps prevent human error"), dict(name="numerics", description="Numerics-related guideline"), dict(name="undefined-behavior", description="Guideline related to Undefined Behavior"), dict(name="stack-overflow", description="Guideline related to Stack Overflow"), - dict(name="maintainability", description="Maintainability-related guideline"), - dict(name="portability", description="Portability-related guideline"), + dict(name="maintainability", description="How effectively and efficiently a product or system can be modified. This includes improvements, fault corrections, and adaptations to changes in the environment or requirements. It is considered a crucial software quality characteristic."), + dict(name="portability", description="The degree to which a system, product, or component can be effectively and efficiently transferred from one hardware, software, or other operational or usage environment to another."), dict(name="surprising-behavior", description="Guideline related to surprising or unexpected behavior"), + dict(name="types", description="Guideline associated with the correct use of types"), dict(name="subset", description="Guideline associated with the language-subset profile"), dict(name="defect", description="Guideline associated with the defect-prevention profile"), ] From 0c11d6be918441c8b25f591e2a10565c45de7626 Mon Sep 17 00:00:00 2001 From: "Robert C. Seacord" Date: Wed, 3 Dec 2025 18:28:28 -0500 Subject: [PATCH 2/2] Update src/conf.py MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Félix Fischer --- src/conf.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/conf.py b/src/conf.py index 9a2aee0a2..74a13d5c6 100644 --- a/src/conf.py +++ b/src/conf.py @@ -104,8 +104,7 @@ dict(name="safety", description="The degree to which a product or system avoids endangering human life, health, property, or the environment under defined operating conditions."), dict(name="performance", description="Performance-related guideline"), dict(name="readability", description="Readability-related guideline"), - dict(name="understandability", description="Understandability is a sub-characteristic of usability in the ISO/IEC 25000 quality model, which measures how easy it is for users to understand the functions and usage of a software product. It is also a separate quality characteristic for data, referring to how well data can be read and interpreted by users with the help of appropriate languages, symbols, and units. -"), + dict(name="understandability", description="Understandability is a sub-characteristic of usability in the ISO/IEC 25000 quality model, which measures how easy it is for users to understand the functions and usage of a software product. It is also a separate quality characteristic for data, referring to how well data can be read and interpreted by users with the help of appropriate languages, symbols, and units."), dict(name="reduce-human-error", description="Guideline that helps prevent human error"), dict(name="numerics", description="Numerics-related guideline"), dict(name="undefined-behavior", description="Guideline related to Undefined Behavior"),