Documentation linting (spellchecker, formatter for md files)
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- build-system, ci-cd, documentation
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.
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.
- Dominant language
- Go
- Stars
- 91
- Forks
- 16
- Avg merge
- 9h 3m
- Merged PRs (30d)
- 24
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.
More from docker/secrets-engine
-
Linux keychain dials a new D-Bus connection per operation, defeating per-entry access confirmation Open
Difficulty 5/5 Over a week Newbie friendliness 42/100
docker/secrets-engine#648 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
docker/secrets-engine#584 · 1 comment · 1 reaction ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
docker/secrets-engine#551 · 2 comments · 3 reactions ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
docker/secrets-engine#534 · 15 comments · 4 reactions ·
-
Dynamic Scopes Open
docker/secrets-engine#393 · 1 assignee ·
All issues in docker/secrets-engine
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
enhancement needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
kind/cleanup
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
kubernetes-sigs/kueue#15947 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100