From 2c488fb4e5020de2b0629934c9edbf0fa7858b28 Mon Sep 17 00:00:00 2001 From: Travis Plunk Date: Wed, 20 Feb 2019 13:24:26 -0800 Subject: [PATCH] Fix Markdown lint issues (#8929) #8896 Broke the static analysis CI. Fixing so CI passes --- .github/CONTRIBUTING.md | 9 ++++---- .github/ISSUE_TEMPLATE/Support_Question.md | 1 - .github/PULL_REQUEST_TEMPLATE.md | 12 +++++----- docs/community/governance.md | 27 ++++++++++++---------- docs/host-powershell/README.md | 3 ++- test/common/markdown/markdown.tests.ps1 | 9 +------- 6 files changed, 29 insertions(+), 32 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ee131f8cc9..a8aad26e93 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -60,13 +60,13 @@ To run the spellchecker, follow these steps: * install [markdown-spellcheck](https://github.com/lukeapage/node-markdown-spellcheck) by `npm install -g markdown-spellcheck` (v0.11.0 or up) * run `mdspell "**/*.md" --ignore-numbers --ignore-acronyms --en-us` -* if the `.spelling` file is updated, commit and push it +* if the `.spelling` file is updated, commit and push it -#### Checking links in documentation +#### Checking links in documentation Documentation is link-checked. We make use of the markdown-link-check command line tool, -which can be run to see if any links are dead. +which can be run to see if any links are dead. To run the link-checker, follow these steps: @@ -190,7 +190,8 @@ Additional references: Company = "Microsoft Corporation" Copyright = "Copyright (c) Microsoft Corporation. All rights reserved." ``` - is at the top. + + is at the top. ### Pull Request - Work in Progress diff --git a/.github/ISSUE_TEMPLATE/Support_Question.md b/.github/ISSUE_TEMPLATE/Support_Question.md index 70150da729..46eb13f3f9 100644 --- a/.github/ISSUE_TEMPLATE/Support_Question.md +++ b/.github/ISSUE_TEMPLATE/Support_Question.md @@ -7,7 +7,6 @@ assignees: '' --- - # Support Question ## Official support diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ac71fd1e95..5e6a9aa669 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,10 @@ - + -## PR Summary +# PR Summary - + -## PR Context +## PR Context @@ -16,10 +16,10 @@ - [ ] [Change is not breaking](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes) - [ ] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress). - - If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready. + - If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready. - **User-facing changes** - [ ] Not Applicable - - **OR** + - **OR** - [ ] [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] Issue filed: - **Testing - New and feature** diff --git a/docs/community/governance.md b/docs/community/governance.md index 98c7fcd65e..ec72ec2e2c 100644 --- a/docs/community/governance.md +++ b/docs/community/governance.md @@ -2,17 +2,20 @@ ## Terms -* [**PowerShell Committee**](#powershell-committee): A committee of project owners who are responsible for design decisions, approving [RFCs][RFC-repo], and approving new maintainers/committee members +* [**PowerShell Committee**](#powershell-committee): A committee of project owners who are responsible for design decisions, + approving [RFCs][RFC-repo], and approving new maintainers/committee members * [**Repository maintainer**](#repository-maintainers): An individual responsible for merging pull requests (PRs) into `master` when all requirements are met (code review, tests, docs, and RFC approval as applicable). -Repository Maintainers are the only people with write permissions for the `master` branch. + Repository Maintainers are the only people with write permissions for the `master` branch. * [**Area experts**](#area-experts): People who are experts for specific components (e.g. PSReadline, the parser) or technologies (e.g. security, performance). -Area experts are responsible for code reviews, issue triage, and providing their expertise to others. -* **Corporation**: The Corporation owns the PowerShell repository and, under extreme circumstances, reserves the right to dissolve or reform the PowerShell Committee, the Project Leads, and the Corporate Maintainer. -The Corporation for PowerShell is Microsoft. -* **Corporate Maintainer**: The Corporate Maintainer is an entity, person or set of persons, with the ability to veto decisions made by the PowerShell Committee or any other collaborators on the PowerShell project. -This veto power will be used with restraint since it is intended that the community drive the project. -The Corporate Maintainer is determined by the Corporation both initially and in continuation. -The initial Corporate Maintainer for PowerShell is Jeffrey Snover ([jpsnover](https://github.com/jpsnover)). + Area experts are responsible for code reviews, issue triage, and providing their expertise to others. +* **Corporation**: The Corporation owns the PowerShell repository and, under extreme circumstances, + reserves the right to dissolve or reform the PowerShell Committee, the Project Leads, and the Corporate Maintainer. + The Corporation for PowerShell is Microsoft. +* **Corporate Maintainer**: The Corporate Maintainer is an entity, person or set of persons, + with the ability to veto decisions made by the PowerShell Committee or any other collaborators on the PowerShell project. + This veto power will be used with restraint since it is intended that the community drive the project. + The Corporate Maintainer is determined by the Corporation both initially and in continuation. + The initial Corporate Maintainer for PowerShell is Jeffrey Snover ([jpsnover](https://github.com/jpsnover)). * [**RFC process**][RFC-repo]: The "review-for-comment" (RFC) process whereby design decisions get made. ## PowerShell Committee @@ -57,7 +60,7 @@ If any Committee Members feels like this behavior is large enough to warrant an As a PowerShell Committee Member: 1. **DO** reply to issues and pull requests with design opinions -(this could include offering support for good work or exciting new features) + (this could include offering support for good work or exciting new features) 1. **DO** encourage healthy discussion about the direction of PowerShell 1. **DO** raise "red flags" on PRs that haven't followed the proper RFC process when applicable 1. **DO** contribute to documentation and best practices @@ -68,7 +71,7 @@ As a PowerShell Committee Member: 1. **DON'T** constantly raise "red flags" for unimportant or minor problems to the point that the progress of the project is being slowed 1. **DON'T** offer up your opinions as the absolute opinion of the PowerShell Committee. -Members are encouraged to share their opinions, but they should be presented as such. + Members are encouraged to share their opinions, but they should be presented as such. ### PowerShell Committee Membership @@ -109,7 +112,7 @@ If you are an Area Expert: 1. **DO** assign yourself to issues labeled with your area of expertise 1. **DO** code reviews for issues where you're assigned or in your areas of expertise. 1. **DO** reply to new issues and pull requests that are related to your area of expertise -(while reviewing PRs, leave your comment even if everything looks good - a simple "Looks good to me" or "LGTM" will suffice, so that we know someone has already taken a look at it). + (while reviewing PRs, leave your comment even if everything looks good - a simple "Looks good to me" or "LGTM" will suffice, so that we know someone has already taken a look at it). 1. **DO** make sure contributors are following the [contributor guidelines](../../.github/CONTRIBUTING.md). 1. **DO** ask people to resend a pull request, if it [doesn't target `master`](../../.github/CONTRIBUTING.md#lifecycle-of-a-pull-request). 1. **DO** ensure that contributors [write Pester tests][pester] for all new/changed functionality diff --git a/docs/host-powershell/README.md b/docs/host-powershell/README.md index 1f14267b2f..3d96855b41 100644 --- a/docs/host-powershell/README.md +++ b/docs/host-powershell/README.md @@ -43,4 +43,5 @@ such as the in-box `powershell.exe` in Nano Server and the Azure DSC host. For such hosting scenarios, the native host needs to bootstrap by calling [`PowerShellAssemblyLoadContextInitializer.SetPowerShellAssemblyLoadContext`](https://docs.microsoft.com/dotnet/api/system.management.automation.powershellassemblyloadcontextinitializer.setpowershellassemblyloadcontext). When using this API, the native host can pass in the path to the directory that contains PowerShell assemblies. -A handler will then be registered to the [`Resolving`](https://github.com/dotnet/corefx/blob/d6678e9653defe3cdfff26b2ff62135b6b22c77f/src/System.Runtime.Loader/ref/System.Runtime.Loader.cs#L38) event of the default load context to deal with the loading of assemblies from that directory. +A handler will then be registered to the [`Resolving`](https://github.com/dotnet/corefx/blob/d6678e9653defe3cdfff26b2ff62135b6b22c77f/src/System.Runtime.Loader/ref/System.Runtime.Loader.cs#L38) +event of the default load context to deal with the loading of assemblies from that directory. diff --git a/test/common/markdown/markdown.tests.ps1 b/test/common/markdown/markdown.tests.ps1 index e273680b1b..0bb182f946 100644 --- a/test/common/markdown/markdown.tests.ps1 +++ b/test/common/markdown/markdown.tests.ps1 @@ -42,7 +42,7 @@ Describe 'Common Tests - Validate Markdown Files' -Tag 'CI' { Write-Warning "Node and npm are required to run this test" $skip = $true } - + $mdIssuesPath = Join-Path -Path $PSScriptRoot -ChildPath "markdownissues.txt" Remove-Item -Path $mdIssuesPath -Force -ErrorAction SilentlyContinue } @@ -60,20 +60,13 @@ Describe 'Common Tests - Validate Markdown Files' -Tag 'CI' { $docsToTest = @( './.github/*.md' './README.md' - './CODE_OF_CONDUCT.md' './demos/python/*.md' './docker/*.md' - './docs/*.md' './docs/building/*.md' - './docs/debugging/*.md' - './docs/git/*.md' './docs/community/*.md' './docs/host-powershell/*.md' - './docs/dev-process/*.md' './docs/cmdlet-example/*.md' './docs/maintainers/*.md' - './docs/learning-powershell/*.md' - './docs/testing-guidelines/*.md' './test/powershell/README.md' './tools/*.md' './.github/ISSUE_TEMPLATE/*.md'