Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (35 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 1.72 KB

Contributing

Contributions are welcome. Fork this repository and open a pull request to propose changes. Consider submitting an issue to discuss any proposed changes with the maintainers before submitting a pull request.

Development

Clone this repository:

git clone https://github.com/nextflow-io/vscode-language-nextflow
cd vscode-language-nextflow

Install dependencies:

(cd webview-ui ; npm install)
npm install

If you need to edit the language server, clone the repository and build it:

git clone https://github.com/nextflow-io/language-server
make server

Finally, in VS Code or Cursor, press F5 to build the extension and launch a new workspace with the extension loaded (alternatively you can run Debug: Start Debugging from the command palette).

You will be prompted to enter a path to your Nextflow workspace, which defaults to ../test-workspace relative to the project directory.

Alternatively, you can run the Webview UI with live reload:

npm run ui-watch

Publishing

  1. Update the extension version number in package.json.
  2. Update the changelog in CHANGELOG.md.
  3. Make a release commit e.g. "Release 1.0.0".
  4. Create a release in GitHub e.g. "v1.0.0".
  5. Run the "Publish Extension" action to publish the extension to the Visual Studio Marketplace and Open VSX Registry.

Additional resources