修改 mdlint 中的非包含字詞

Fuchsia 使用 mdlint,這個 Markdown Linter 針對 Fuchsia 來源樹狀結構中的說明文件強制執行特定規則。mdlint 包含非包容的語言偵測工具,使用 JSON 檔案包含非包含的字詞及其各自的替代項目。

如何更新、移除或新增非多元包容的語言清單:

更新清單

  1. 開啟 /tools/mdlint/rules/respectful_code_words.json
  2. 如要新增或修改非包含字詞的建議,請加上半形逗號並撰寫新的建議。例如:

    "master": "main, primary,new suggestion",
    

從清單中移除

  1. 開啟 /tools/mdlint/rules/respectful_code_words.json
  2. 刪除包含不包含在內的字詞和建議字詞的整行。

加到清單

  1. 開啟 /tools/mdlint/rules/respectful_code_words.json
  2. 根據清單中字詞的字母順序,在字詞之間新增一行。
  3. 新增字詞及個別的多元包容建議。例如:

    "non-inclusive word": "first inclusive suggestion, second inclusive suggestion...",