microsoft/Terminal

Integrate VSCode's Markdown Linter into CI

Open

#4,635 opened on Feb 18, 2020

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)C++ (9,275 forks)batch import
Area-BuildHelp WantedIssue-TaskProduct-Terminal

Repository metrics

Stars
 (103,173 stars)
PR merge metrics
 (Avg merge 27d 19h) (24 merged PRs in 30d)

Description

PR #4615 used the VS Code Markdown Linter to clean up our markdown a bit. It'd be nice if we could make this a part of our CI and just add it to the Invoke-CodeFormat tool in \tools\OpenConsole.psm1.

It looks like the PowerShell team is integrating at the project level, unsure about their CI integrations: https://github.com/PowerShell/PowerShell/blob/master/.vscode/extensions.json#L10 https://github.com/PowerShell/PowerShell/blob/master/.vscode/settings.json#L10 Originally posted by @rpunt in https://github.com/microsoft/terminal/pull/4615#issuecomment-587504180

Contributor guide

Research direction
Investigate how to integrate the VS Code Markdown Linter into the CI pipeline by adding it to the Invoke CodeFormat tool in tools/OpenConsole.psm1. Look at the PowerShell team's example for inspiration.
Tech stack
shell
Domain
ci cd
Issue type
DevOps
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75