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:

yarn install

Then add SDKs for you preferred editor as described on https://yarnpkg.com/getting-started/editor-sdks if you want IDE support.

Build from source

Build bundle

yarn run build

Testing

Set up the tests once, via:

yarn run setup-tests

Build with source-map for testing:

yarn run build:bundle-dev

Run to have a proper test suite pass:

yarn test

Coding Style guide & standard

Apply the coding style via:

yarn 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 --signoff ...

Doing so adds a message to your commit message as described in https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s