Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repolinter: Adding PolicyInfo and PolicyUrl to all checks #209

Open
natalialuzuriaga opened this issue Nov 20, 2024 · 1 comment
Open

Repolinter: Adding PolicyInfo and PolicyUrl to all checks #209

natalialuzuriaga opened this issue Nov 20, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers intern repolinter

Comments

@natalialuzuriaga
Copy link
Collaborator

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

@natalialuzuriaga natalialuzuriaga added intern documentation Improvements or additions to documentation good first issue Good for newcomers repolinter labels Nov 22, 2024
@natalialuzuriaga
Copy link
Collaborator Author

#84 is related!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers intern repolinter
Projects
None yet
Development

No branches or pull requests

1 participant