Community Guidelines
====================

We encourage the broader community to contribute to ``pysr3``! Please
submit a pull request on GitHub if you fixed a bug or developed an
extension. If you experience any issues please open a new issue on the
Issues page, and we will do our best to help.

As a community, we follow the list of rules below:

1. We adhere to `sklearn’s interfaces and
   standards <https://scikit-learn.org/stable/developers/develop.html>`__

   -  Please use ``sklearn.utils.estimator_checks.check_estimator`` to
      ensure that your contributions don’t break this compatibility.

2. For comments and docstrings, we use `numpy dostring
   standards <https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard>`__
3. For version numbers, we use `Semantic
   Versioning <https://semver.org/>`__.
4. We pledge to `Contributor
   Covenant <https://www.contributor-covenant.org/version/2/0/code_of_conduct/>`__
   code of conduct.

Developing ``pysr3``
--------------------

``pysr3`` does not require any special hardware and can be developed on
your personal computer. To start, install ``pysr3`` in the developer
mode:

.. code:: bash

   git clone https://github.com/aksholokhov/pysr3.git
   cd pysr3
   python setup.py develop

Testing ``pysr3``
-----------------

To test the installation, invoke the tests with ``pytest``:

.. code:: bash

   pytest .