Contributing

We are pleased that you would like to contribute to ICX360. We welcome both reporting issues and submitting pull requests.

Reporting issues

Please make sure to include any potentially useful information in the issue, so we can pinpoint the issue faster without going back and forth.

• What SHA of ICX360 are you running? If this is not the latest SHA on the main branch, please try if the problem persists with the latest version.
• Python versions

Contributing a change

Contributions to this project are released to the public under the project's opensource license.

Contributors must sign off that they adhere to these requirements by adding a Signed-off-by line to all commit messages with an email address that matches the commit author:

feat: this is my commit message

Signed-off-by: Random J Developer <random@developer.example.org>

Coding Style Guidelines We are using tools to enforce code style: - iSort, to sort imports - Black, to format code

We run a series of checks on the codebase on every commit using pre-commit. To install the hooks, run: pre-commit install

To run the checks on-demand, run: pre-commit run --all-files

Contributing to documentation

uv pip install -e ".[docs]"

We use MkDocs to write documentation.

To run the documentation server, run:

mkdocs serve

The server will be available at http://localhost:8000.

Pushing Documentation to GitHub Pages

Run the following:

mkdocs gh-deploy

Submitting a pull request

1. Fork and clone the repository
2. Create a new branch: git checkout -b my-branch-name
3. Make your change, push to your fork and submit a pull request
4. Wait for your pull request to be reviewed and merged.