Skip to content

Conversation

wesley-dean
Copy link
Contributor

Proposed Changes

  1. adds a plugin for @adrienverge's yamllint to lint YAML front matter in Markdown documents.

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

@echoix
Copy link
Collaborator

echoix commented Apr 23, 2025

If you could update the title, or include a changelog entry, it would be helpful when doing the release. Otherwise, it's fine if the remaining checks pass

@wesley-dean wesley-dean changed the title Update plugins.yml Add fmlint (frontmatter linter) to plugins list Apr 24, 2025
@nvuillam
Copy link
Member

@wesley-dean please can you update .cspell.json to fix the linter issue ? :)

@wesley-dean
Copy link
Contributor Author

wesley-dean commented Apr 24, 2025 via email

@wesley-dean
Copy link
Contributor Author

The typo has been corrected and the cspell list of ignored words has been updated. Thanks for the feedback!

@wesley-dean
Copy link
Contributor Author

General question: should additions to documentation (e.g., the inclusion of additional plugins) be documented in the changelog?

@echoix
Copy link
Collaborator

echoix commented Apr 25, 2025

General question: should additions to documentation (e.g., the inclusion of additional plugins) be documented in the changelog?

Good point. I would go with no. The goal is to have plugins that we don't need to maintain, and are of a different scope of our repo. We happen to also act as the "registry" in the same project, so it may be a bit unfortunate. I believe that plugins should be merged in a timely manner and easier, as they shouldn't be the same level of support as the main project.

@echoix echoix merged commit 389e87d into oxsecurity:main Apr 25, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants