Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

57 lines (36 loc) · 1.81 KB
Raw

Contributing

The software is provided as is, there is no warranty of any kind. All users are encouraged to improve the source code with fixes and new features contributed by means of Pull Requests.

Prerequisites

Run

npm install

to populate the dependencies in ./node_modules directory.

Setup for consuming GitHub Registry public packages

run-cmake depends on public NPM packages published by lukka/run-cmake-vcpkg-action-libs in the GitHub Packages registry. Unexpectedly, a public package still requires authentication when downloading it, hence if you want to npm install those packages correctly, you need to obtain a token with read:packages scope. Then create in the root of the repository a .npmrc file with the following content:

    //npm.pkg.github.com/:_authToken=YOURTOKEN
    @lukka:registry=https://npm.pkg.github.com/

Note: Never commit this .npmrc file!

Build and lint

Build with tsc running:

npm run build

Launch lint by:

npm run lint

Packaging

To build, lint validate and package the extension for release purpose, run:

npm run pack

Testing

To build, pack and test:

npm run test

To run test directly:

npx jest

Validation tests on various scenarios are run using the workflows of the Samples.