Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements to QC.Lic #101

Merged
merged 9 commits into from
Aug 11, 2023
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
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<p float="left">
<img src="content/images/logo-SYNERGY.png" height="50">
<img src="content/images/logo-DEEP.png" height="50">
<img src="content/images/logo-XDC.png" height="50">
<img src="content/images/logo-INDIGO.png" height="50">
</p>
## Institutions owning the Result

<p float="left">
<img src="content/images/logo-LIP.png" height="50">
Expand All @@ -22,6 +15,15 @@
<img src="content/images/logo-UPV.png" height="50">
</p>

## Projects developing the document

<p float="left">
<img src="content/images/logo-SYNERGY.png" height="50">
<img src="content/images/logo-DEEP.png" height="50">
<img src="content/images/logo-XDC.png" height="50">
<img src="content/images/logo-INDIGO.png" height="50">
</p>

## Motivation

Research software development and maintenance often suffers from a lack of
Expand Down
15 changes: 0 additions & 15 deletions content/00.front-matter.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,6 @@
##}
_A DOI-citable version of this manuscript is available at <http://hdl.handle.net/10261/160086>_.

{## Template to insert build date and source ##}
<small><em>
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 <https://gitlab.com/manubot/rootstock/>.
</em></small>

## Authors

{## Template for listing authors ##}
Expand Down
15 changes: 12 additions & 3 deletions content/06.quality_criteria.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,19 +149,28 @@ 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].

* **[QC.Lic02.1]** **RECOMMENDED** licenses are listed in the Open Source Initiative portal under
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
Expand Down
1 change: 1 addition & 0 deletions content/08.annex.md
Original file line number Diff line number Diff line change
Expand Up @@ -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** | <https://tox.readthedocs.io/> | Automated test framework |
| bandit | **QC.Sec** | Python | <https://bandit.readthedocs.io/> | Static security |
| licensee | **QC.Lic** | Agnostic | <https://github.com/licensee/licensee> | Check license |
| reuse-tool | **QC.Lic** | Agnostic | https://github.com/fsfe/reuse-tool | Check compliance with REUSE specification |
| cff-converter-python | **QC.Met** | Agnostic | <https://github.com/citation-file-format/cff-converter-python> | Code metadata |
| checkCitable | **QC.Met** | Agnostic | <https://github.com/EOSC-synergy/sqa-composer-templates/tree/main/QC.Met> | Code metadata |
| markdownlint | **QC.Doc** | Markdown | <https://github.com/markdownlint/markdownlint> | Documentation |
Expand Down