We absolutely welcome any code contributions and we hope that this
guide will facilitate an understanding of the review-bot
code
repository. It is important to note that while the review-bot
software
package is maintained by ANSYS and any submissions will be reviewed
thoroughly before merging, we still seek to foster a community that can
support user questions and develop new features to make this software
a useful tool for all users. As such, we welcome and encourage any
questions or submissions to this repository.
For contributing to this project, please refer to the PyAnsys Developer's Guide.
Installing in developer mode allows you to modify the source and enhance it.
Before contributing to the project, please refer to the PyAnsys Developer's guide. You will need to follow these steps:
-
Start by cloning this repository:
git clone https://github.com/ansys/review-bot
-
Create a fresh-clean Python environment and activate it:
# Create a virtual environment python -m venv .venv # Activate it in a POSIX system source .venv/bin/activate # Activate it in Windows CMD environment .venv/Scripts/Activate.bat # Activate it in Windows Powershell .venv/Scripts/Activate.ps1
-
Install the project in editable mode:
python -m pip install -e .
If required, you can always call the style commands (black, isort, flake8) or unit testing ones (pytest) from the command line. However, this does not guarantee that your project is being tested in an isolated environment, which is the reason why tools like tox exist.