SQA documentation

This framework provides various services regarding to software quality.

Description

This software is built as a python package, distributed as docker image. Its goal is to help researchers, developers and RSEs develop software with better quality. Currently there are two ways to run the services.

Requirements

The software you want to run the services on must be a git repository with a remote location named ‘origin’.

via GitLab CI/CD

• available GitLab-Runner with the docker-executor

local usage

• docker >= 19.03.1

Structure of the Documentation

• Installation
  • General
  • Requirements
  • From Source
• Usage
  • General
  • GitLab CI/CD
  • Local
• Services
  • general
  • --apply_license (-al)
  • --check_credentials (-c)
  • --list-authors (-la)
  • --list-used-languages (-lla)
  • --list-used-licenses (-lli)
• Configuration
  • Initialize
  • Apply License
  • Check Credentials
  • List used Licenses
• Templates
  • Initialize
  • Apply License
• Authors
• Contributing
  • Types of Contributions
  • Commit Changes
  • Merge Request Guidelines
• Changelog
• SQA report
• Source Code