reactjs / reactjs/react.dev

Spellchecking content and other Markdown files in CI

オープン
#473 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
JavaScript
スター
11.8k
フォーク
7.9k
平均マージ
1日 11時間
マージ済み PR(30日)
11

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

リポジトリの CI 設定と、README.md を含むドキュメントおよび Markdown ファイルを確認し、提案されている spellchecker-cli をどのように呼び出すかを判断します。CI の範囲を定義する前に、Markdown およびテキストファイルに対してツールがサポートする動作を確認します。選択したファイルが CI 中に保守しやすい設定で自動的にスペルチェックされれば完了です。

索引モデルが issue の本文から書いたものです。

評価

領域
ci-cd, documentation
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。