Developer

If you want to develop a feature or fix a bug for this project, you'll need to follow the following steps to ensure the project will compile.

Prerequisites

• Visual Studio (VS) 2022 Community Edition (or higher)

VS Solution Setup

Simple clone this repo and start developing.
This repo used the official CmdPal nuget package, so it shouldn't require any special setup.

1. Fork then clone to your local disk
   git clone https://github.com/lin-ycv/EverythingCommandPalette.git --depth 1
2. Open solution in VS. Develop and compile as needed

• If there's errors about nuget package, do a package restore.

Build

Normal builds aren't that helpful, since CmdPal only loads extensions through "packaged COM activation".
If you're debugging, simply launch the Debugger, but CS/WinRT doesn't expose anything helpful to CmdPal about exceptions thrown in the extension process - only that one happened.
If you want to do a local install from the solution, use the Deploy option.
If you want to generate a app package, use Pack or Publish -> Create App Package

Contributor

Translator

With VS

This is the recommended method, as VS Resource Explorer makes it easy to cross-compare the value you are editing. However, it does require you to install VS.

1. Clone ECP repo
2. Skip step 2 if you're editing a pre-existing translation
   • Duplicate Resources.resx in Properties folder and rename to Resource.(Locale code).resx
     • ie: Resources.zh-tw.resx
     • Locale code is made up of 2 parts ISO 639-1 language code and ISO 3166-1 country code
3. Open solution in VS
4. Navigate to Resource Explorer and edit the values as needed.
5. Create a PR

Without VS

This method does not require you to install any additional software, as you can open resx files in notepad.

1. • If creating a new translation:
     • Download the English Resource file and rename to Resource.(Locale code).resx
       • ie: Resources.zh-tw.resx
       • Locale code is made up of 2 parts ISO 639-1 language code and ISO 3166-1 country code
   • If editing a pre-existing translation:
     • Download the respective Resource file
2. Edit the <value> field
   • If you don't have a translation for a certain value, or if you wish to use the English text, you can simply delete the data tag for that value
3. Create a PR

Documentation

If there's any issues with any documentations, please open a Discussion, or create a PR with the appropriate fixes