diff --git a/README.md b/README.md index eacc40c..1a9125a 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,7 @@ [![PDF Manuscript](https://img.shields.io/badge/manuscript-PDF-blue.svg)](https://indigo-dc.github.io/sqa-baseline/manuscript.pdf) [![Build Status](https://travis-ci.org/indigo-dc/sqa-baseline.svg?branch=master)](https://travis-ci.org/indigo-dc/sqa-baseline) -## Main contributing projects and institutes - -

- - - - -

+## Institutions owning the Result

@@ -22,6 +15,15 @@

+## Projects developing the document + +

+ + + + +

+ ## Motivation Research software development and maintenance often suffers from a lack of diff --git a/content/00.front-matter.md b/content/00.front-matter.md index 58c450d..0562770 100644 --- a/content/00.front-matter.md +++ b/content/00.front-matter.md @@ -13,21 +13,6 @@ ##} _A DOI-citable version of this manuscript is available at _. -{## Template to insert build date and source ##} - -This manuscript -{% if manubot.ci_source is defined and manubot.ci_source.provider == "appveyor" -%} -([permalink]({{manubot.ci_source.artifact_url}})) -{% elif manubot.html_url_versioned is defined -%} -([permalink]({{manubot.html_url_versioned}})) -{% endif -%} -was automatically generated -{% if manubot.ci_source is defined -%} -from [{{manubot.ci_source.repo_slug}}@{{manubot.ci_source.commit | truncate(length=7, end='', leeway=0)}}](https://github.com/{{manubot.ci_source.repo_slug}}/tree/{{manubot.ci_source.commit}}) -{% endif -%} -on {{manubot.date}} with the use of . - - ## Authors {## Template for listing authors ##} diff --git a/content/06.quality_criteria.md b/content/06.quality_criteria.md index 9435f33..6b3d3fc 100644 --- a/content/06.quality_criteria.md +++ b/content/06.quality_criteria.md @@ -149,12 +149,16 @@ set of change-based tests. ### 4.2.1. Licensing [QC.Lic] * **[QC.Lic01]** As open-source software, source code **MUST** adhere to an open-source license to - be freely used, modified and distributed by others. Non-licensed software is exclusive copyright - by default. + be freely studied, used, modified and distributed by others. Non-licensed software is exclusive + copyright by default. - * **[QC.Lic01.1]** Licenses **MUST** be physically present (e.g. as a LICENSE file) in the root + * **[QC.Lic01.1]** Licenses **MUST** be physically present (e.g. as a `LICENSE` file) in the root of all the source code repositories related to the software component. + * **[QC.Lic01.2]** Additionally, licenses **MAY** be physically present in a `LICENSES` folder + in the root path of the code repository, in compliance with the REUSE specification. This is + specially suitable when the code uses multiple licenses. + * **[QC.Lic02]** License **MUST** be compliant with the Open Source Definition [@https://opensource.org/osd]. @@ -162,6 +166,11 @@ set of change-based tests. the Popular Licenses category [@https://opensource.org/licenses], c.f. the complete list of Software Package Data Exchange (SPDX) [@https://spdx.org/licenses]. +* **[QC.Lic03]** For the sake of accuracy, and in line with **[QC.Lic01.2]**, it is **RECOMMENDED** + that all files (both text plain and binary) present in the code repository reflect the licensing + information. This can be done using the SPDX file tag `SPDX-FileCopyrightText`, placed as a + comment at the top of the file. + ### 4.2.2. Code metadata [QC.Met] Metadata for the software component provides a way to achieve its full identification, thus making diff --git a/content/08.annex.md b/content/08.annex.md index 7acb50f..f740efe 100644 --- a/content/08.annex.md +++ b/content/08.annex.md @@ -108,6 +108,7 @@ applicable programming language. This list is based on the template file in | tox | **QC.Sty**, **QC.Uni**, **QC.Sec**, **QC.Doc** | | Automated test framework | | bandit | **QC.Sec** | Python | | Static security | | licensee | **QC.Lic** | Agnostic | | Check license | +| reuse-tool | **QC.Lic** | Agnostic | https://github.com/fsfe/reuse-tool | Check compliance with REUSE specification | | cff-converter-python | **QC.Met** | Agnostic | | Code metadata | | checkCitable | **QC.Met** | Agnostic | | Code metadata | | markdownlint | **QC.Doc** | Markdown | | Documentation |