Skip to content
A set of Common Software Quality Assurance Baseline Criteria for Research Projects
Branch: master
Clone or download
orviz Merge pull request #20 from dhimmel/rootstock-2019-04-01
PR to upgrade Manubot to 2019-04-01 Rootstock
Latest commit f835d0a Apr 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
build
ci Update Manubot on 2019-04-01 Apr 1, 2019
content
output Update for expanded manubot package (#48) Aug 9, 2017
webpage Refactor HTML assets to build/themes & build/plugins Jan 28, 2019
.gitignore Support BUILD_PDF=false environment variable Nov 9, 2018
.travis.yml CI: only deploy on push TRAVIS_EVENT_TYPE Mar 2, 2019
CONTRIBUTING.md
LICENSE-CC0.md
LICENSE.md
README.md

README.md

A set of Common Software Quality Assurance Baseline Criteria for Research Projects

HTML Manuscript PDF Manuscript Build Status

Motivation

Research software development and maintenance often suffers from a lack of quality assurance realization. This might result from the fact that the different actors involved are either not aware of the benefits that applying quality practices bring along, or not keen to adhere to them as they might increase the burden on the software life cycle. Thus, the main purpose of this document is to provide a lightweight and practical approach to educate and, ultimately, achieve quality in the development of research software.

The Common Software Quality Assurance Baseline Criteria establishes the minimum viable set of quality requirements that shall be covered when tackling any software development project, but mainly oriented to research. Additional best practices and recommendations are also defined to increase the value --reliability, interoperability-- of the final product. In order to discern among them, the RFC 2119 convention is used throughout the document, thus adding adequate information about the criticality of each requirement.

A citable version of this manuscript is available at http://hdl.handle.net/10261/160086

Open Collaboration

The current baseline has been elaborated and extended based on the first-hand experiences extracted from several European-funded research projects for software development. We aim to consolidate the quality guidelines as a reference point for future research projects, setting a path for sustainability and knowledge transfer. This goal can only be achieved through a open and collaborative effort. Consequently, any contribution is welcomed and will be considered for inclusion.

Please check our contribution guide.

Copyright Notice

Copyright © Members of the INDIGO-DataCloud, DEEP Hybrid-DataCloud and eXtreme DataCloud collaborations, 2015-2020.

License

License: CC BY-SA 4.0

The Common Software Quality Assurance Baseline Criteria is licensed under a CC-BY SA 4.0. See LICENSE.md.

Acknowledgments

The INDIGO-DataCloud, DEEP-Hybrid-DataCloud and eXtreme-DataCloud projects have received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement number 653549, 777435 and 777367 respectively.

Manuscript generated with Manubot
You can’t perform that action at this time.