Skip to content

Latest commit

 

History

History
67 lines (52 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

67 lines (52 loc) · 2.42 KB

Contributing

Setting up your environment

  1. Install NodeJS, Elixir and Erlang

    The recommended installation method is through asdf or mise:

    asdf 
    asdf plugin add nodejs
# Make sure you have the required dependencies https://github.com/asdf-vm/asdf-elixir?tab=readme-ov-file#install
asdf plugin add elixir
# Make sure you have the required dependencies https://github.com/asdf-vm/asdf-erlang?tab=readme-ov-file#before-asdf-install
asdf plugin add erlang
asdf install
    mise 
    # Make sure you have the required dependencies
# https://github.com/asdf-vm/asdf-elixir?tab=readme-ov-file#install
# https://github.com/asdf-vm/asdf-erlang?tab=readme-ov-file#before-asdf-install
mise plugin install --all -y
mise install

  2. Install dependencies: npm install

Starting the extension

Press F5. VSCode should build and start the extension.

Installing the extension globally

npm run vsce:package
code --install-extension *.vsix

Publishing the extension

  1. Make sure the version number has been updated in package.json and in CHANGELOG.md if there are any unreleased documented changes
  2. Log in to your Azure DevOps account
    1. Create an Azure DevOps organization if you don't already have one. The organization name doesn't matter, you simply need one to access Azure DevOps and create a Personal Access Token.
    2. Create a Personal Access Token with the "Manage Marketplace" scope if you don't already have one.
    3. Login in to vsce: npm run vsce:login with your Personal Access Token
  3. Publish the extension to the VSCode marketplace: npm run vsce:publish
  4. Follow steps 1 through 3 on this page to setup you Open VSX account and create an access token
  5. Publish the extension to Open VSX: npm run ovsx:publish -- <your access token>