Contributing
============

SysIdentPy is intended to be a community project, hence all contributions are welcome!

Suggestions and Bug reporting
----------------------------
There exist many possible use cases in System Identification field
and we can not test all scenarios without your help! If you find any
bugs or have suggestions, please report them on 'issue tracker'_ on GitHub.

.. _`issue tracker`: https://github.com/wilsonrljr/sysidentpy/issues

Documentation
-------------

Documentation is as important as the library itself. English is not the primary language of the main authors, so if you find any typo or anything wrong do not hesitate to point out to us.

Development environment
-----------------------

These are some basic steps to help us with code:

1. Install and Setup Git on your computer.
3. `Fork sysidentpy <https://help.github.com/articles/fork-a-repo/>`_.
4. `Clone the fork on your local machine  <https://help.github.com/articles/cloning-a-repository/>`_.
5. Install it in development mode using
:code:`pip install --editable /path/to/sysidentpy/[dev]`

6. Create a new branch.
7. Make changes following the coding style of the project (or suggesting improvements).
8. Run the tests.
9. Write and/or adapt existing test if needed.
10. Add documentation if needed.
11. Commit.
12. `Push to your fork <https://help.github.com/articles/pushing-to-a-remote/>`_.
13. `Open a pull request! <https://help.github.com/articles/creating-a-pull-request/>`_