.. _ref_contributing:

Contribute
==========

Overall guidance on contributing to a PyAnsys library appears in the
`Contributing <dev_guide_contributing_>`_ topic
in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
with this guide before attempting to contribute to PyAnsys Math.

The following contribution information is specific to PyAnsys Math.

Clone the repository
--------------------

Run this code to clone and install the latest version of PyAnsys Math in development mode::

    git clone https://github.com/ansys/pyansys-math
    cd pyansys-math
    python -m pip install --upgrade pip
    pip install -e .

Post issues
-----------

Use the `PyAnsys Math Issues <pymath_issues_>`_ page to submit questions,
report bugs, and request new features. When possible, use these issue
templates:

* Bug report template
* Feature request template

If your issue does not fit into one of these categories, create your own issue.

To reach the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.


Build documentation
-------------------

To build the PyAnsys Math documentation locally, in the root directory of the repository, run::
    
    pip install .[doc]
    .\doc\make.bat html 

Documentation for the latest stable release of PyAnsys Math is hosted at
`PyAnsys Math Documentation <pymath_docs_>`_.

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
--------------------

PyAnsys Math follows the PEP8 standard as outlined in the `PyAnsys Development Guide
<dev_guide_pyansys_>`_ and implements style checking using
`pre-commit <precommit_>`_.

To ensure your code meets minimum code styling standards, run this code::

  pip install pre-commit
  pre-commit run --all-files

You can also install this as a pre-commit hook by running this code::

  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
  codespell................................................................Passed
  check for merge conflicts................................................Passed
  debug statements (python)................................................Passed
  Validate GitHub Workflows................................................Passed