microsoft / microsoft/terminal
Integrate VSCode's Markdown Linter into CI
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 105k
- Forks
- 9.6k
- Avg merge
- 3d 17h
- Merged PRs (30d)
- 29
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in tools\OpenConsole.psm1 at the Invoke-CodeFormat tool, then review PR #4615 and the linked VS Code extension and settings examples. Determine how the Markdown Linter should be integrated into the existing CI and formatting flow; done means Markdown linting runs as part of that flow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell, vscode
- Domain
- ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100