Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.71 KB

Contributing

JSer.info記事上部の Edit on GitHub、又は、下部の この記事へ修正リクエストをする から修正を送れます。

Pull Request

記事からGitHubで直接編集してPull Requestを送ることが出来ます。

ちょっとした誤字脱字でもご気軽に修正を送ってくださると助かります。

自動校正

textlintを使った自動校正のチェックが入っています。

などがCIで実行されています。

lint-image

チェック対象となった場合の対応

Lintのチェック結果に対して次のような対応を取ることが出来ます。

  1. コメントに応じて修正する
  2. azu/technical-word-rulesの辞書を修正する
  3. 例外的なので無視する(Lintの手法がおかしいなど)

辞書は完璧ではないので、辞書の方を直したほうが良い場合はコメントなどして下さい。

ローカルでLintする方法

npm install
# 編集したファイルだけを対象にする場合
npm run textlint
# or ファイルを指定する場合
npm run lint -- /path/to/file.md

でLintをかけることが出来ます。