Description
Is your feature request related to a problem? Please describe.
Currently, we use repolinter to check if certain files and section/content exist in a repository. Using GH action, we publish an issue to a repository with a report on what checks have passed and failed.
Describe the solution you'd like
Let's add policyInfo
and policyUrl
text for all checks in repolinter.json so when repolinter issues are published, users have a better idea of the purpose of the check and how to resolve it.
Describe alternatives you've considered
Simply pointing to links/docs on our maturity model framework but this is not as well-integrated / doesn't not connect the dots as well as above.
Additional context
Example of how other repos do it!
https://github.com/aperture-science-incorporated/companion-cube/blob/main/test_policy.yaml
aperture-science-incorporated/companion-cube#62