You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It is suggested to use markdown-lint extension of VSCode or some other tool(s) to automate the linting of the markdown files. The linting rules may also be configured for the exceptions in .markdownlint.json file and this may be added to this project to enforce the recommended Markdown format setting.
This integration may somehow be automated to create a CI pipeline for the submitted PRs.
The redis-doc is worth to look at. It uses Aspell for spelling mistakes.
Other relevant tools and/or solutions may also be suggested to automate the CI which would definitely help all the future work adhere to the recommended practices resulting in to-the-point reviews i.e. documentation and not the style, spelling, and grammar issues.
Regards!
The text was updated successfully, but these errors were encountered:
iamazeem
changed the title
Suggestion: Markdown Linting
Suggestion: Markdown Linting with Spelling and Grammar Reporting (Possible automated CI pipeline)
Aug 8, 2020
It is suggested to use markdown-lint extension of VSCode or some other tool(s) to automate the linting of the markdown files. The linting rules may also be configured for the exceptions in
.markdownlint.json
file and this may be added to this project to enforce the recommended Markdown format setting.This integration may somehow be automated to create a CI pipeline for the submitted PRs.
The redis-doc is worth to look at. It uses Aspell for spelling mistakes.
Other relevant tools and/or solutions may also be suggested to automate the CI which would definitely help all the future work adhere to the recommended practices resulting in to-the-point reviews i.e. documentation and not the style, spelling, and grammar issues.
Regards!
The text was updated successfully, but these errors were encountered: