microsoft / microsoft/DevSkim

CLI Suppress Command Does not properly comment XML suppressions

Open
#588 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
C#
Stars
1k
Forks
132
Avg merge
1m
Merged PRs (30d)
1

Description

Describe the bug
When running the suppress command in the CLI on a finding in an XML document the suppression is added but the required comment block (<!-- -->) around it is not.

Image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the CLI suppress command and follow its XML-specific output handling, reproducing the issue with a finding in an XML document. Done means the generated suppression is wrapped in the required comment block and the relevant behavior is covered by a test if the existing CLI test structure identifies one.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
cli, security
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.