CONTRIBUTING.md

Contributing to ITBench-Scenarios

ITBench-Scenarios accepts contributions through GitHub pull request.

Required Software

• Python3 (v3.12.z)

Environment Set Up Guide

1. Create a Python virtual environment.

python -m venv venv

2. Install the Python dependencies

python -m pip install -r requirements-dev.txt

3. Install pre-commit to the repo. This only needs to be done once.

pre-commit install
pre-commit install --hook-type commit-msg --hook-type pre-push

Committing Code

This project requires the use of the following tools:

• Ansible Lint
• commitizen
• detect-secrets
• pre-commit

These tools are installed through the process mentioned here.

All commits submitted to this repository must be signed, pass the pre-commit tests, and formatted through commitizen.

In order to sign and commit code using commitizen, please run the following command after staging changes via git add:

cz commit -- --signoff