Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (43 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 1.49 KB
Raw

Contributing

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

Issues

When creating a new issue, please select the appropriate issue type from the available templates and fill out the provided form.
These templates ensure that all necessary information is captured consistently.

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

Install dependencies:

npm run dev-setup

This will install process automatically build the project from source.

Build from source

npm run build-dev

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