# Contributing

Any contribution is welcome.
Please read the CycloneDX contributing guidelines first.

Pull-requests from forks are welcome.
We love to see your purposed changes, but we also like to discuss things first. Please open a ticket and explain your intended changes to the community. And don’t forget to mention that discussion in your pull-request later. Find the needed basics here:

- how to fork a repository

- how create a pull request from a fork

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

## Setup

This project uses poetry. Have it installed and setup first.

To install dev-dependencies and tools:

    poetry install --all-extras

## Code style

This project loves latest python features.
This project loves sorted imports.
This project uses PEP8 Style Guide for Python Code.

Get it all applied via:

    poetry run -- tox r -e pyupgrade -- --exit-zero-even-if-changed
    poetry run -- tox r -e isort
    poetry run -- tox r -e autopep8

This project prefers `f'strings'` over `'string'.format()`.
This project prefers `'single quotes'` over `"double quotes"`.
This project prefers `lower_snake_case` variable names.

## Documentation

This project uses Sphinx to generate documentation which is automatically published to readthedocs.io.

Source for documentation is stored in the `docs` folder in RST format.

You can generate the documentation locally by running:

    cd docs
    pip install -r requirements.txt
    make html

## Testing

Run all tests in dedicated environments, via:

    poetry run tox run

See also: python test snapshots docs

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

## Pre-commit hooks

If you like to take advantage of pre-commit hooks, you can do so to cover most of the topics on this page when contributing.

    pre-commit install

All our pre-commit checks will run locally before you can commit!