From 903af2d14c89ff166c6518fc47c13093f3295cfc Mon Sep 17 00:00:00 2001 From: Andres Montero Date: Wed, 20 May 2026 16:38:02 +0200 Subject: [PATCH 1/2] New indicators (fixes #9 and fixes #149) --- .../archived_in_scholarly_repository.json | 2 +- indicators/code_churn_ok.json | 28 +++++++++++++++++ .../code_documentation_coverage_ok.json | 28 +++++++++++++++++ indicators/passed_tests_ok.json | 31 +++++++++++++++++++ indicators/software_is_containerized.json | 28 +++++++++++++++++ 5 files changed, 116 insertions(+), 1 deletion(-) create mode 100644 indicators/code_churn_ok.json create mode 100644 indicators/code_documentation_coverage_ok.json create mode 100644 indicators/passed_tests_ok.json create mode 100644 indicators/software_is_containerized.json diff --git a/indicators/archived_in_scholarly_repository.json b/indicators/archived_in_scholarly_repository.json index 8c81e82..3773c84 100644 --- a/indicators/archived_in_scholarly_repository.json +++ b/indicators/archived_in_scholarly_repository.json @@ -4,7 +4,7 @@ "@type": "SoftwareQualityIndicator", "name": "Software is archived in a scholarly repository", "abbreviation": "archived_in_scholarly_repository", - "description": "The source code repository is archived in a scholarly repository (e.g Zenodo, HAL) to ensure that software can be found and accessed in a scholarly context ", + "description": "The source code repository is archived in a scholarly repository (e.g Zenodo, HAL) to ensure that software can be found and accessed in a scholarly context.", "source": { "@id": "https://fair-impact.github.io/RSMD-guidelines/8.rsmd_checklist/", "url": "https://fair-impact.github.io/RSMD-guidelines/8.rsmd_checklist/#accessibility-and-preservation", diff --git a/indicators/code_churn_ok.json b/indicators/code_churn_ok.json new file mode 100644 index 0000000..52196cc --- /dev/null +++ b/indicators/code_churn_ok.json @@ -0,0 +1,28 @@ +{ + "@context": "https://w3id.org/everse/rsqi#", + "@id": "https://w3id.org/everse/i/indicators/code_churn_ok", + "@type": "SoftwareQualityIndicator", + "name": "Code churn follows community conventions", + "abbreviation": "code_churn_ok", + "description": "The code churn (how much a source code has changed over time) of the project's source code is maintained within a reasonable level according to the community's standards and conventions. An example of how to calculate it would be code churn = added lines + deleted lines.", + "source": { + "url": "https://ieeexplore.ieee.org/document/738486", + "name": "Code churn: a measure for estimating the impact of code change" + }, + "keywords": ["code", "churn", "maintainability"], + "identifier": { "@id": "https://w3id.org/everse/i/indicators/code_churn_ok"}, + "contact": [ + { + "@type": "schema:Person", + "name": "Daniel Garijo" + }, + { + "@type": "schema:Person", + "name": "Andres Montero" + } + ], + "status": "Active", + "version": "1.0.0", + "qualityDimension": { "@id": "https://w3id.org/everse/i/dimensions/maintainability"}, + "created": "20-05-2026" + } diff --git a/indicators/code_documentation_coverage_ok.json b/indicators/code_documentation_coverage_ok.json new file mode 100644 index 0000000..978d58b --- /dev/null +++ b/indicators/code_documentation_coverage_ok.json @@ -0,0 +1,28 @@ +{ + "@context": "https://w3id.org/everse/rsqi#", + "@id": "https://w3id.org/everse/i/indicators/code_documentation_coverage_ok", + "@type": "SoftwareQualityIndicator", + "name": "The documentation coverage for the codebase follows community conventions", + "abbreviation": "code_documentation_coverage_ok", + "description": "This check tries to determine if the project's codebase is mostly documented according according to community conventions and standards (i.e. docstrings).", + "source": { + "url": "", + "name": "" + }, + "keywords": ["documentation", "docstring", "documentation coverage"], + "identifier": { "@id": "https://w3id.org/everse/i/indicators/code_documentation_coverage_ok"}, + "contact": [ + { + "@type": "schema:Person", + "name": "Daniel Garijo" + }, + { + "@type": "schema:Person", + "name": "Andres Montero" + } + ], + "status": "Active", + "version": "1.0.0", + "qualityDimension": { "@id": "https://w3id.org/everse/i/dimensions/maintainability"}, + "created": "20-05-2026" + } diff --git a/indicators/passed_tests_ok.json b/indicators/passed_tests_ok.json new file mode 100644 index 0000000..e429b46 --- /dev/null +++ b/indicators/passed_tests_ok.json @@ -0,0 +1,31 @@ +{ + "@context": "https://w3id.org/everse/rsqi#", + "@id": "https://w3id.org/everse/i/indicators/passed_tests_ok", + "@type": "SoftwareQualityIndicator", + "name": "Passed tests by the software follows community conventions", + "abbreviation": "passed_tests_ok", + "description": "The software passes a reasonable amount of the tests provided within its own repository according to community's conventions and standards.", + "source": { + "url": "https://docs.codecov.com/docs/about-code-coverage", + "name": "About Code Coverage" + }, + "keywords": ["tests", "test", "functionality"], + "identifier": { "@id": "https://w3id.org/everse/i/indicators/passed_tests_ok"}, + "contact": [ + { + "@type": "schema:Person", + "name": "Daniel Garijo" + }, + { + "@type": "schema:Person", + "name": "Andres Montero" + } + ], + "status": "Active", + "version": "1.0.0", + "qualityDimension": [ + { "@id": "https://w3id.org/everse/i/dimensions/fairness" }, + { "@id": "https://w3id.org/everse/i/dimensions/functional_suitability" } + ], + "created": "20-05-2026" + } diff --git a/indicators/software_is_containerized.json b/indicators/software_is_containerized.json new file mode 100644 index 0000000..28a951c --- /dev/null +++ b/indicators/software_is_containerized.json @@ -0,0 +1,28 @@ +{ + "@context": "https://w3id.org/everse/rsqi#", + "@id": "https://w3id.org/everse/i/indicators/software_is_containerized", + "@type": "SoftwareQualityIndicator", + "name": "The project's repository includes a container build file", + "abbreviation": "software_is_containerized", + "description": "The project's repository where its source code is hosted includes a container build file (i.e. Dockerfile, Podman, Apptainer, etc.).", + "source": { + "url": "https://escape-ossr.gitlab.io/ossr-pages/contribute/checklist/", + "name": "Software Package Checklist" + }, + "keywords": ["container", "fair", "containerized", "docker"], + "identifier": { "@id": "https://w3id.org/everse/i/indicators/software_is_containerized"}, + "contact": [ + { + "@type": "schema:Person", + "name": "Daniel Garijo" + }, + { + "@type": "schema:Person", + "name": "Andres Montero" + } + ], + "status": "Active", + "version": "1.0.0", + "qualityDimension": { "@id": "https://w3id.org/everse/i/dimensions/fairness" }, + "created": "20-05-2026" + } From 1e929c8ae14b275012ba01a70acdd523feb6c383 Mon Sep 17 00:00:00 2001 From: Andres Montero Date: Mon, 25 May 2026 08:40:42 +0200 Subject: [PATCH 2/2] changes requested --- indicators/code_documentation_coverage_ok.json | 9 ++++++--- indicators/passed_tests_ok.json | 4 ++-- indicators/software_is_containerized.json | 2 +- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/indicators/code_documentation_coverage_ok.json b/indicators/code_documentation_coverage_ok.json index 978d58b..82c804e 100644 --- a/indicators/code_documentation_coverage_ok.json +++ b/indicators/code_documentation_coverage_ok.json @@ -6,8 +6,8 @@ "abbreviation": "code_documentation_coverage_ok", "description": "This check tries to determine if the project's codebase is mostly documented according according to community conventions and standards (i.e. docstrings).", "source": { - "url": "", - "name": "" + "url": "https://interrogate.readthedocs.io/en/latest/", + "name": "interrogate" }, "keywords": ["documentation", "docstring", "documentation coverage"], "identifier": { "@id": "https://w3id.org/everse/i/indicators/code_documentation_coverage_ok"}, @@ -23,6 +23,9 @@ ], "status": "Active", "version": "1.0.0", - "qualityDimension": { "@id": "https://w3id.org/everse/i/dimensions/maintainability"}, + "qualityDimension": [ + { "@id": "https://w3id.org/everse/i/dimensions/maintainability"}, + { "@id": "https://w3id.org/everse/i/dimensions/fairness"} + ], "created": "20-05-2026" } diff --git a/indicators/passed_tests_ok.json b/indicators/passed_tests_ok.json index e429b46..9b2448c 100644 --- a/indicators/passed_tests_ok.json +++ b/indicators/passed_tests_ok.json @@ -2,9 +2,9 @@ "@context": "https://w3id.org/everse/rsqi#", "@id": "https://w3id.org/everse/i/indicators/passed_tests_ok", "@type": "SoftwareQualityIndicator", - "name": "Passed tests by the software follows community conventions", + "name": "All tests defined by the software component pass", "abbreviation": "passed_tests_ok", - "description": "The software passes a reasonable amount of the tests provided within its own repository according to community's conventions and standards.", + "description": "The software tool passes all the tests provided within its own repository.", "source": { "url": "https://docs.codecov.com/docs/about-code-coverage", "name": "About Code Coverage" diff --git a/indicators/software_is_containerized.json b/indicators/software_is_containerized.json index 28a951c..6446c23 100644 --- a/indicators/software_is_containerized.json +++ b/indicators/software_is_containerized.json @@ -4,7 +4,7 @@ "@type": "SoftwareQualityIndicator", "name": "The project's repository includes a container build file", "abbreviation": "software_is_containerized", - "description": "The project's repository where its source code is hosted includes a container build file (i.e. Dockerfile, Podman, Apptainer, etc.).", + "description": "The project's repository where its source code is hosted includes a container build file to containerize it (i.e. Dockerfile, Podman, Apptainer, etc.).", "source": { "url": "https://escape-ossr.gitlab.io/ossr-pages/contribute/checklist/", "name": "Software Package Checklist"