CONTRIBUTING.md

Contributing

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

Setup

To start developing simply run to install dev-dependencies and tools:

npm ci

This will install process automatically build the project from source.

Build from source

npm run build

Testing

Set up the tests once, via:

npm run setup-tests

Run to have a proper test suite pass:

npm test

Coding Style guide & standard

Apply the coding style 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 ...