About Pull Requests (PR)

1. Prerequisite: Read About the JSON structure of completions first.
2. Fork the PSCompletions repository and clone it locally for your changes.
3. After finishing your edits, commit and open a Pull Request.

Updating JSON content

TIP

• Improve completion tip text (the tip field).
• Add any missing commands or options.

1. Link the completion for testing:

   .\scripts\link-completion.ps1 git

2. Check known gaps:

   .\scripts\compare-json.ps1 git

3. When done, update its guid:

   .\scripts\update-guid.ps1 git

Adding a new language

TIP

Example: add zh-HK support for git.

1. Edit completions\git\config.json and append zh-HK to the language array.

2. Create completions\git\language\zh-HK.json and translate the tip strings.

3. Update the guid:

   .\scripts\update-guid.ps1 git

Creating a new command completion

Using test as an example.

1. Create the new completion:

   .\scripts\create-completion.ps1 test

2. Modify the new completion and config.json as needed.

3. Update the guid:

   .\scripts\update-guid.ps1 test