How to Contribute

Contributions are encouraged from anyone. This project follows the Code of Conduct by the Python Software Foundation.

Please use the following steps to get started:

Fork and clone the repo:

$ git clone [email protected]:your-username/prsw.git

Make your changes and include tests for your change.

Run the static analysis tools locally to help ensure it fits within the project expectations:

$ python pre_push.py

pre_push.py: Success!

Push your fork and submit a pull request.

Please follow these simple guidelines:

Always add documentation for your code and do your best to write meaningful tests.
Follow PEP 8.
Write good commit messages