https://github.com/stariongroup/vcd-generator

A Verification Control Document Generator
https://github.com/stariongroup/vcd-generator

requirements system-engineering verification

Last synced: 6 months ago
JSON representation

A Verification Control Document Generator

• Host: GitHub
• URL: https://github.com/stariongroup/vcd-generator
• Owner: STARIONGROUP
• License: apache-2.0
• Created: 2022-11-02T11:25:45.000Z (over 3 years ago)
• Default Branch: development
• Last Pushed: 2024-10-06T11:05:29.000Z (over 1 year ago)
• Last Synced: 2025-09-25T23:17:39.274Z (6 months ago)
• Topics: requirements, system-engineering, verification
• Language: C#
• Homepage: https://www.stariongroup.eu
• Size: 152 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          

# VCD-Generator

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_VCD-Generator&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_VCD-Generator)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_VCD-Generator&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_VCD-Generator)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_VCD-Generator&metric=coverage)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_VCD-Generator)

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_VCD-Generator&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_VCD-Generator)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_VCD-Generator&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_VCD-Generator)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_VCD-Generator&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_VCD-Generator)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_VCD-Generator&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_VCD-Generator)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_VCD-Generator&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_VCD-Generator)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_VCD-Generator&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_VCD-Generator)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=STARIONGROUP_VCD-Generator&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_VCD-Generator)

The purpose of the VCD Generator is to create Verification Control Documents (reports) that make record of which tests contribute to the verification of a set of Requirements. The VCD Generator is available on [Nuget](https://www.nuget.org/packages/vcdg) as a dotnet tool called `vcdg`.

The VCD Generator works in combination with NUnit and currently generates reports in 2 forms:

  - Excel Spreadsheet

  - HTML Table

The VCD Generator needs 2 inputs:

  - Requirements: in tabular form (excel spreadsheet), where one of the columns needs to contain the human readable unique identifier of the requirements.

  - Nunit results: in xml form generated using the `NunitXml.TestLogger` logger

Please read the [Quick Start](https://github.com/STARIONGROUP/VCD-Generator/wiki/Quick-Start) to find out how to use the `vcdg` dotnet tool

## Build Status

GitHub actions are used to build and test the library

Branch | Build Status

------- | :------------

Master | ![Build Status](https://github.com/STARIONGROUP/VCD-Generator/actions/workflows/CodeQuality.yml/badge.svg?branch=master)

Development | ![Build Status](https://github.com/STARIONGROUP/VCD-Generator/actions/workflows/CodeQuality.yml/badge.svg?branch=development)

# License

The VCD-Generator libraries are provided to the community under the Apache License 2.0.

# Contributions

Contributions to the code-base are welcome. However, before we can accept your contributions we ask any contributor to sign the Contributor License Agreement (CLA) and send this digitaly signed to s.gerene@stariongroup.eu. You can find the CLA's in the CLA folder.