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.

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

Move QA test for Markdown style "Common Tests - Validate Markdown Files" #55

Open
johlju opened this issue Jan 2, 2020 · 0 comments
Open
Labels
help wanted The issue is up for grabs for anyone in the community. tests The issue or pull request is about tests only.

Comments

@johlju
Copy link
Member

johlju commented Jan 2, 2020

We should move the QA test for markdown files.

https://github.com/PowerShell/DscResource.Tests/blob/dev/Meta.Tests.ps1#L861

This is text I removed from the SqlServerDsc repo that should be added (or something similar) to the guidelines on the DSC Community site.

#### Unit tests for style check of Markdown files

When sending in a Pull Request (PR) a style check will be performed on all Markdown
files, and if the tests find any error the build will fail.
See the section [Documentation with Markdown](#documentation-with-markdown) how
these errors kan be found before sending in the PR.

The Markdown tests can be run locally if the packet manager 'npm' is available.
To have npm available you need to install [node.js](https://nodejs.org/en/download/).
If 'npm' is not available, a warning text will print and the rest of the tests
will continue run.
@johlju johlju added help wanted The issue is up for grabs for anyone in the community. tests The issue or pull request is about tests only. labels Jan 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted The issue is up for grabs for anyone in the community. tests The issue or pull request is about tests only.
Projects
None yet
Development

No branches or pull requests

1 participant