All contributions are welcome and greatly appreciated. The best way to contribute is to submit a bug report or feature request. You can also fork the project and submit a pull request or contribute to open issues.
Something wrong? If you find that something is not working properly, please submit a bug report. In the bug report, please include all relevant and detailed information such as version, operating system, error messages, and steps to reproduce the bug. The more information, the better!
Have an awesome idea for a new feature and want it added? Please submit a feature request. It is always great to hear new ideas on how the project can be improved.
You are welcome to fork the project, implement the feature yourself, and submit a pull request. The preferred method would to open an issue describing the feature to open a discussion before implementing the feature.
If you would like to contribute by a new enhancement or feature, please fork the project and once you are done, please submit a pull request with the feature.
Please keep bug reports, feature requests, and pull requests as detailed and specific as possible. I'd prefer to have lots of small tasks instead of a small list of large tasks. Thanks!
-
Variables and functions should follow
lower_casenaming convention. The only exception is for constants, which should useUPPER_CASE. -
Prefer local variables instead of global variables.
If you have any questions about anything, feel free to email me!