Spellchecking content and other Markdown files in CI
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
Hi there! I've created a command-line tool that checks Markdown and text files for spelling mistakes and some types of grammatical errors. I think it could be useful to run this tool on the documentation and other Markdown files (e.g. README.md) in this repository during CI. If this sounds interesting to you, I'm happy to open a PR.
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
Review the repository's CI configuration and the documentation and Markdown files, including README.md, to determine how the proposed spellchecker-cli would be invoked. Check the tool's supported Markdown and text-file behavior before defining the CI scope. Done means the selected files are spellchecked automatically during CI with a maintainable configuration.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100