.. _contributing:

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

Contributions are what make the open source community such an amazing place to learn, 
inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create 
a pull request. You can also simply open an issue with the tag "enhancement".

Set up a local environment
--------------------------

1. Clone or fork the repository

    .. code-block:: console

        $ git clone https://github.com/MatrixEditor/pysmali.git

2. Install the required dependencies:

    .. code-block:: console

        $ pip install -r ./pysmali/requirements.txt


Create a new feature request
----------------------------

* Fork the Project
* Create your Feature Branch (``git checkout -b feature/AmazingFeature``)
* Commit your Changes (``git commit -m 'Add some AmazingFeature'``)
* Push to the Branch (``git push origin feature/AmazingFeature``)
* Open a Pull Request