Contribute

Overall guidance on contributing to a PyAnsys library appears in the Contributing topic in the PyAnsys Developer’s Guide. Ensure that you are thoroughly familiar with this guide before attempting to contribute to PySherlock.

The following contribution information is specific to PySherlock.

Post issues

Use the `https://github.com/pyansys/pysherlock/issues`_ page to submit questions, report bugs, and request new features.

Adhere to code style

PySherlock is compliant with the PyAnsys code style. It uses the tool pre-commit to check the code style. You can install and activate this tool with:

python -m pip install pre-commit
pre-commit install

You can then use the style rule defined in Makefile with:

make style

Or, you can directly execute pre-commit with:

pre-commit run --all-files --show-diff-on-failure