About Pull Requests (PR)

1. Read About the definition of completion first.
2. Fork the PSCompletions repository and clone it locally for your changes.
3. After finishing your edits, commit and open a Pull Request.
   • Before submitting, run .\scripts\compare-json.ps1 <name> again.
   • Ensure there are no red errors in the output.

Updating JSON content

TIP

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

1. Link the completion to preview it in real-time:

   .\scripts\link-completion.ps1 git

2. Check known gaps:

   .\scripts\compare-json.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.

Creating a new command completion

Using test as an example.

1. Create the new completion:

   .\scripts\create-completion.ps1 test

2. Link the completion to preview it in real-time:

   .\scripts\link-completion.ps1 test

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