how_to_contribute.md

Contributing to vscode-pddl extension

Are you looking for the End-user documentation?

Building extension

Run npm install.

This will ensure the extension dependencies are downloaded using the --no-optional switch.

Packaging extension

Install the VS Code extension packaging tool:

npm install -g vsce

On Windows, you can use the publish.cmd script to review the content of the package before building it, installing it, testing it and possibly publishing it. The extension is published to the marketplace automatically by the GitHub CI/CD workflow, when the master branch is updated and the version number was bumped.

Testing the extension

Run npm test when all VS Code windows are closed.

Making a release

Modify following files:

• Update the version in package.json (adhere to the major.minor.patch semantic versioning practice)
• Add section about new features and fixes on top of the CHANGELOG.md and refer to Git tag at the bottom of the file
• Add relevant end-user documentation about new features to README.md
• Submit pull request

Credits

Icons made by Pixel perfect from www.flaticon.com is licensed by CC 3.0 BY.

Development of this extension was supported by Schlumberger. Visit careers.slb.com.