ComplianceAsCode / ComplianceAsCode/auditree-framework

Report template enhancement - evidence/config

Open
#44 0 comments 0 reactions 0 assignees View on GitHub
enhancement report
Dominant language
Python
Stars
76
Forks
25
PR merge metrics
No merged PRs in 30d

Description

## Overview

Feedback provided identified gaps in reports generated out of checks. To that end we should consider updating the framework to provide evidence and configuration used as part of each report generated by a check.

## Requirements

### Consider:

More thought and research required...

- Inject all evidence used by the check into every **markdown** report.
- Inject configuration used by the check into every **markdown** report.
- If report template being used isn't markdown then skip the above two.
- Both evidence and configuration should be attached to the bottom of every report as collapsible markdown text.

## Approach

- TBD

## Security and Privacy

N/A

## Test Plan

TBD

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.