fluent / fluent/fluentd-docs-gitbook
Suggestion: Markdown Linting with Spelling and Grammar Reporting (Possible automated CI pipeline)
- 主要言語
- CSS
- スター
- 46
- フォーク
- 136
- 平均マージ
- 4時間 47分
- マージ済み PR(30日)
- 16
説明
It is suggested to use [markdown-lint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) 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](https://github.com/redis/redis-doc) is worth to look at. It uses [Aspell](http://aspell.net/) 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!
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
調査の方向性
まず、提案されている .markdownlint.json 設定と、issue 内の markdown-lint および Aspell への参照を確認します。redis-doc のアプローチと比較し、その後、リポジトリで利用可能な CI のエントリーポイントを調査します。プロジェクトで lint とスペルチェックの方針について合意され、提出された PR に対する自動チェックが用意されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- markdown
- 領域
- ci-cd, documentation
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100