关于 PR (Pull Request)

1. 前提: 你应该先阅读 关于补全的 json 文件结构
2. 你应该 fork PSCompletions 仓库， clone 到本地进行修改
3. 只要修改了补全文件，都需要更新其目录下的 guid.txt 文件
   • 你可以手动运行 New-Guid 生成，将值填入此文件中
   • 也可以直接运行 .\scripts\update-guid.ps1
4. 修改完成后，提交并创建 PR

1. 更新 json 文件内容

• 完善补全的一些提示信息(tip 属性)
• 添加补全的一些缺失的命令
  • 可以通过 .\scripts\compare-json.ps1 脚本来查看未完成的部分
    • 以 git 举例
    • 你可以使用以下命令查看 zh-CN.json 文件缺少的属性(相较于 en-US.json 文件)
      • .\scripts\compare-json.ps1 .\completions\git\language\zh-CN.json .\completions\git\language\en-US.json
    • 如果是和 config.json 中配置的第一个语言对比，也可以省略第二个参数
      • .\scripts\compare-json.ps1 .\completions\git\language\zh-CN.json

2. 添加语言

1. 在项目的 completions 目录中找到你想要添加语言的补全
2. 在其目录下的 config.json 文件中的 language 属性里添加像 zh-CN 这样的语言标识符
3. 在 language 目录下添加与语言标识符同名的 json 文件
   • 你可以将原有的一个 json 文件直接复制，改名即可
4. 翻译其中的 tip 属性的内容即可

3. 添加一个全新的命令补全

1. 在项目根目录下运行 .\scripts\create-completion.ps1
   • 为了调试方便，create-completion.ps1 会将创建的补全目录链接到实际 PSCompletions 的 completions 目录下
     • 因此，必须先安装并导入 PSCompletions 模块，然后再运行 create-completion.ps1
       • Install-Module PSCompletions -Scope CurrentUser
       • Import-Module PSCompletions
   • 当提交 PR 并被合并后，你应该使用 psc rm 移除掉此补全，并使用 psc add 重新添加
2. 根据提示进行操作
3. 修改新创建的补全
4. 根据需求修改 config.json