docker / docker/secrets-engine
Documentation linting (spellchecker, formatter for md files)
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 91
- Forks
- 16
- Avg merge
- 9h 3m
- Merged PRs (30d)
- 24
Description
We need a CI linter on PRs for documentation - anything ending in a .md extension.
It should check:
- Spelling
- Grammar
- Formatting
It should run as a CI job (following the pattern of existing jobs) and probably also be a make command so we can run it locally.
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
Review the repository's existing CI jobs and Make commands first, then identify how files ending in .md are selected. Done means a CI job checks spelling, grammar, and formatting on pull requests, with the same checks runnable locally through a make command.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100