Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (40 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 1.36 KB

Contributing

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

Pullrequests

When opening a pull request, use the repository’s pull request template and complete all required fields.
Keep each pull request focused on a single topic or problem.

Every pull request must reference an existing issue that it aims to address.
If no issue exists for your topic, please create one first using the appropriate issue template, then link your pull request to it.

Set up the project

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

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 --s ...