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

Fix README Markdownlint Validation Failures #145

Merged
merged 7 commits into from
Jun 3, 2019

Conversation

X-Guardian
Copy link
Contributor

@X-Guardian X-Guardian commented Apr 28, 2019

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 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
Copy link

codecov-io commented May 24, 2019

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

Copy link
Contributor

@mhendric mhendric left a comment

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 @X-Guardian)


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

* Fix README markdownlint validation failures

Can you move this entry into the Unreleased section?

Copy link
Contributor Author

@X-Guardian X-Guardian left a comment

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 @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.

Copy link
Contributor

@mhendric mhendric left a comment

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

Copy link
Contributor

@mhendric mhendric left a comment

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 mhendric merged commit e88fdd5 into PowerShell:dev Jun 3, 2019
@X-Guardian 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.
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
Development

Successfully merging this pull request may close these issues.

4 participants