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 PyRocky.
The following contribution information is specific to PyRocky.
Clone the repository#
To clone and install the latest PyRocky release in development mode, run these commands:
git clone https://github.com/ansys/pyrocky
cd pyrocky
python -m pip install --upgrade pip
pip install -e .
Post issues#
Use the PyRocky Issues page to submit questions, report bugs, and request new features. When possible, you should use these issue templates:
Bug, problem, error: For filing a bug report
Documentation error: For requesting modifications to the documentation
Adding an example: For proposing a new example
New feature: For requesting enhancements to the code
If your issue does not fit into one of these template categories, you can click the link for opening a blank issue.
To reach the project support team, email pyansys.core@ansys.com.
View documentation#
Documentation for the latest stable release of PyRocky is hosted at PyRocky Documentation.
In the upper right corner of the documentation’s title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.
Adhere to code style#
PyRocky follows the PEP8 standard as outlined in PEP 8 in the PyAnsys Developer’s Guide and implements style checking using pre-commit.
To ensure your code meets minimum code styling standards, run these commands:
pip install pre-commit
pre-commit run --all-files
You can also install this as a pre-commit hook by running this command:
pre-commit install
This way, it’s not possible for you to push code that fails the style checks:
$ pre-commit install
$ git commit -am "added my cool feature"
black....................................................................Passed
blacken-docs.............................................................Passed
isort....................................................................Passed
flake8...................................................................Passed
docformatter.............................................................Passed
codespell................................................................Passed
pydocstyle...............................................................Passed
check for merge conflicts................................................Passed
debug statements (python)................................................Passed
check yaml...............................................................Passed
trim trailing whitespace.................................................Passed
Add License Headers......................................................Passed
Validate GitHub Workflows................................................Passed