oasisprotocol / oasisprotocol/docs
Add Markdownlint check to CI
Open
Nobody has claimed this yet.
ci
- Dominant language
- TypeScript
- Stars
- 15
- Forks
- 46
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 1
Description
Following up from #27, it would be great to check if there is a Markdownlint GitHub action that would also annotate the errors that a linter finds for a PR and use that.
If not, calling yarn lintmarkdown CLI command is OK.
Related: #2.
Contributor guide
No contributing guide indexed for this repository
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 existing CI configuration and the context in issues #27 and #2. Check whether a Markdownlint GitHub Action can annotate pull-request errors; otherwise use the documented yarn lintmarkdown command. Done means Markdown linting runs in CI and reports failures for pull requests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, markdown
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100