ITADN

Better Reporting - Making scores more impactful

#31Openvipulgupta2048 创建于 2025-04-22
V
vipulgupta2048commented
After almost finishing https://github.com/vipulgupta2048/chps-scorer-github-action, I saw the chps-scorer README mentioning adding updated badges to the README using GitHub Actions. I recommend we provide an option to generate a human-readable report in a markdown file if an output option is present beyond the target to update badges. The badges themselves aren't going to be that impactful imho. Benefits, 1. Report can become a standardized scorecard just like https://openssf.org/projects/scorecard/, 2. The action can use this output to create a more useful GitHub issue for contributors than what it's currently https://github.com/vipulgupta2048/chps-scorer-github-action/issues/5, should feature some remediation steps or resources to check each grade's meaning 3. Current scorer output is missing details that can be expressed in a longer markdown report. Here's how I have used similar Github action output reports, https://github.com/balena-io/docs/issues/3173 to inform better decisions for maintainers. Would love to contribute to the scorer or its underlying specification to make it better and tweak the action. Even bring the action under the chps-dev org. Thanks for building this tool folks!
7 条评论