Improve output for SARIF to make the recommendation and reason clear
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 474
- Forks
- 65
- Avg merge
- 22h 25m
- Merged PRs (30d)
- 26
Description
SARIF output is pulled into downstream tools such as GHAS, when issues are raised anybody reading the details needs to have a clear picture of was it wrong and what steps can be done to fix it.
For example in the following, it is not clear on the next steps or cause of the issue.
This is the output from assert that provides more specific information to the issue.
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
No source file, entry point, or test is identified in the issue. Start by locating the SARIF output generation path in PSRule and compare its generated details with the examples shown. Done means downstream readers can understand both why the issue was raised and what recommendation or remediation steps to take.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- devops
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100