Skip to content

About PR (Pull Request)

  1. Prerequisite: You should read About the structure of completion json file first.

  2. You should fork PSCompletions, and clone to your machine.

    • Run the following command to test the modified content

      sh
      # e.g. git
      .\scripts\link-completion.ps1 git
    • As long as the completion file is modified, the following command needs to be run.

      sh
      # e.g. git
      .\scripts\update-guid.ps1 git
  3. After changing, you should commit and create the PR.

1. Update the content of completion json file

  • Patch some tips of the completion.(tip attributes)
  • Add some missing parts for the completion.
  • The missing parts can be viewed by using the following command.
    sh
    # e.g. git
    .\scripts\compare-json.ps1 git

2. Add language

  1. In the completions directory, select the language you want to add.
  2. Add the language identifier to the language in the config.json file.
  3. Add a json file with the same name as the language identifier in the language directory.
    • You can copy the original json file and rename it.
  4. Translate the contents of the tip attribute.

3. Add a new completion

  1. Run the following command to create a new completion.

    shell
    # e.g. test
    .\scripts\create-completion.ps1 test
  2. Follow the prompts.

  3. Modify the new completion.

  4. Modify config.json as required.