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.

Sign up for GitHub

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

Jump to bottom

Fix devskim configuration documentation #4129

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix devskim configuration documentation #4129

wants to merge 1 commit into from

Conversation

girlpunk
Copy link

Proposed Changes

  1. Correct the documentation for devskim to show a valid example for creating exclusions. The current example is both invalid JSON and will not achieve the expected results.

Readiness Checklist

Author/Contributor

  • Add entry to the CHANGELOG listing the change and linking to the corresponding issue (if appropriate)
  • If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

  • Label as breaking if this is a large fundamental change
  • Label as either automation, bug, documentation, enhancement, infrastructure, or performance

nvuillam
nvuillam requested changes Oct 14, 2024
View reviewed changes
Copy link
Member

@nvuillam nvuillam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This markdown is generated from https://github.com/girlpunk/megalinter/blob/5ae98a34f8aeae2d601cfac4910eb1e680e1b9bf/megalinter/descriptors/repository.megalinter-descriptor.yml#L71 , please can you update there too ? :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@echoix echoix Awaiting requested review from echoix echoix is a code owner

@bdovaz bdovaz Awaiting requested review from bdovaz bdovaz is a code owner

@Kurt-von-Laven Kurt-von-Laven Awaiting requested review from Kurt-von-Laven Kurt-von-Laven is a code owner

@nvuillam nvuillam Awaiting requested review from nvuillam nvuillam is a code owner

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@girlpunk @nvuillam