修改 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...",