StackGuardian / StackGuardian/tirith
feat(output): remediation steps in the verdict — PR comments and reports
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 165
- Forks
- 42
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 11
Description
Add per-policy meta.remediation (markdown text) rendered into the PR comment,
--output-markdown/--output-html and the platform run view, next to the failing resource.
Authored by the policy writer; upstream check libraries publish remediation text for most checks,
which can seed the packs.
Acceptance. A failing policy with meta.remediation shows it in the PR comment and reports;
policies without it render unchanged; the best-practice pack ships with remediation filled in.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Trace the existing PR comment, --output-markdown, --output-html, and platform run view rendering paths, then inspect how the best-practice pack defines policy metadata. Done means failing policies show meta.remediation beside the resource in every output, policies without it remain unchanged, and the best-practice pack includes remediation text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100