Contributing

Pull requests are welcome. But please read the CycloneDX contributing guidelines first.

Be aware: even though this project supports node>=14 on runtime, it requires node>=18 on dev-time.

Set up the project

Install dependencies:

npm run dev-setup

The setup will also build the project.

Build from source

Build the JavaScript:

npm run build

Test the build result

Run the tests:

npm test

See the dedicated test docs for details and advanced instructions.

Coding standards

Apply coding standards via:

npm run cs-fix

Sign off your commits

Please sign off your commits, to show that you agree to publish your changes under the current terms and licenses of the project , and to indicate agreement with Developer Certificate of Origin (DCO).

git commit --signed-off ...