Skip to content
This repository was archived by the owner on Jun 14, 2024. It is now read-only.

Fix README Markdownlint Validation Failures - #145

Merged
Mike Hendrickson (mhendric) merged 7 commits into
PowerShell:devfrom
X-Guardian:markdownlint-fix
Jun 3, 2019
Merged

Fix README Markdownlint Validation Failures#145
Mike Hendrickson (mhendric) merged 7 commits into
PowerShell:devfrom
X-Guardian:markdownlint-fix

Conversation

@X-Guardian

@X-Guardian Simon Heather (X-Guardian) commented Apr 28, 2019 •
edited by kwirkykat
Loading

Copy link
Copy Markdown
Contributor

Pull Request (PR) description

This PR fixes the following markdownlint validation failures IN README.md that are reported in the current AppVeyor tests:

C:\projects\psdscresources\README.md: 683: MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
C:\projects\psdscresources\README.md: 20: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```powershell"]
C:\projects\psdscresources\README.md: 25: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```powershell"]
C:\projects\psdscresources\README.md: 1: MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "master: [![Build status](https..."]

To fix MD041, the build/code coverage information has been moved into a separate Branches section to match the format of other DSC repository README layouts.

This Pull Request (PR) fixes the following issues

None

Task list

  • Added an entry under the Unreleased section of the change log in the README.md.
    Entry should say what was changed, and how that affects users (if applicable).
  • Resource documentation added/updated in README.md.
  • Resource parameter descriptions added/updated in README.md, schema.mof
    and comment-based help.
  • Comment-based help added/updated.
  • Localization strings added/updated in all localization files as appropriate.
  • Examples appropriately added/updated.
  • Unit tests added/updated. See DSC Resource Testing Guidelines.
  • Integration tests added/updated (where possible). See DSC Resource Testing Guidelines.
  • New/changed code adheres to DSC Resource Style Guidelines and Best Practices.

This change is Reviewable

@PlagueHO Daniel Scott-Raynsford (PlagueHO) added the waiting for code fix A review left open comments, and the pull request is waiting for changes to be pushed by the author. label Apr 30, 2019
@codecov-io

Codecov (codecov-io) commented May 24, 2019 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Merging #145 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@         Coverage Diff         @@
##            dev   #145   +/-   ##
===================================
  Coverage    83%    83%           
===================================
  Files        19     19           
  Lines      2760   2760           
  Branches      4      4           
===================================
  Hits       2303   2303           
  Misses      453    453           
  Partials      4      4

mhendric
Mike Hendrickson (mhendric) suggested changes Jun 3, 2019
View reviewed changes

@mhendric Mike Hendrickson (mhendric) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hi X-Guardian, sorry for taking so long to get to this one. Everything looks good, except the change entry in README now needs to be moved back into the 'Unreleased' section. Can you handle that when you get a chance? Thanks.

Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on Simon Heather (@X-Guardian))

README.md, line 610 at r2 (raw file):

* Fix README markdownlint validation failures

Can you move this entry into the Unreleased section?

X-Guardian
Simon Heather (X-Guardian) commented Jun 3, 2019
View reviewed changes

@X-Guardian Simon Heather (X-Guardian) left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on Mike Hendrickson (@mhendric))

README.md, line 610 at r2 (raw file):

Previously, mhendric (Mike Hendrickson) wrote…
* Fix README markdownlint validation failures

Can you move this entry into the Unreleased section?

Done.

mhendric
Mike Hendrickson (mhendric) approved these changes Jun 3, 2019
View reviewed changes

@mhendric Mike Hendrickson (mhendric) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r3.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

mhendric
Mike Hendrickson (mhendric) approved these changes Jun 3, 2019
View reviewed changes

@mhendric Mike Hendrickson (mhendric) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

@mhendric
Mike Hendrickson (mhendric) merged commit e88fdd5 into PowerShell:dev Jun 3, 2019
@X-Guardian
Simon Heather (X-Guardian) deleted the markdownlint-fix branch June 21, 2019 22:20
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer
@mhendric Mike Hendrickson (mhendric) mhendric approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

waiting for code fix A review left open comments, and the pull request is waiting for changes to be pushed by the author.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@X-Guardian @codecov-io @mhendric @PlagueHO @SteveL-MSFT