posit-dev / posit-dev/images-shared
Enforce linting/formatting on Markdown files
Open
Nobody has claimed this yet.
cicd
cvp:0
docker
documentation
needs proposal
qa
tdp:2
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- Avg merge
- 4d 13h
- Merged PRs (30d)
- 22
Description
We should add pre-commit and CI linting/formatting tools for Markdown files to ensure proper formatting across all projects.
I don't know of any tools off the top of my head.
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 by reviewing the repository's pre-commit and CI configuration and locating how Markdown files are handled across the projects. Evaluate suitable Markdown linting and formatting tools, then verify that the chosen checks run in both pre-commit and CI and cover all Markdown files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- build-system, ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100