Metrics

Type: object

This schema defines the structure and values for reporting Q/A metrics for projects.

root project
Type: string

Project Name Corresponding to the Metrics.

root commit
Type: string

Commit-Hash pointing to the state of the codebase used for generating the metrics.

root date
Type: stringFormat: date-time

The date and time when the metrics were recorded.

root coverage
Type: number

Represents the percentage of the codebase that is covered by automated tests.

Value must be greater or equal to 0.0 and lesser or equal to 100.0

root maintainability
Type: enum (of string)

Rating of how easily the codebase can be understood, adapted, and extended.

Must be one of:

  • "A"
  • "B"
  • "C"
  • "D"
  • "E"
  • "F"
  • "N/A"

root reliability
Type: enum (of string)

Stability and dependability of the software.

Same definition as maintainability

root security
Type: enum (of string)

Resilience against security threats and vulnerabilities.

Same definition as maintainability

root technical_debt
Type: enum (of string)

Amount of 'technical debt' in the project.

Same definition as maintainability