Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 1.4 KB

When to contribute

If you want to contribute to the project, please do.

I welcome new ideas and would love to add more features/implementations to this project.

If you have an idea but you don't know how to implement it, you are more than welcome to open an issue with it. If you have a small feature that you want to implement, you are welcome to write it and open a pull request.

If you want to add a major feature, it is recommended to open an issue first, to validate with me that this feature is indeed reasonable for this project.

Contributing Rules

When adding code to this project, please follow these simple rules for the code:

  • Write good commit messages. An explanation of good commit message as I see it can be found here or here.
  • Make sure that your code follows the language conventions, and follow the existing conventions in case you are adding code to already written code.
    • For example, make sure that your code passes all of pylint and pep8 errors when writing python code.
    • Minor reasonable changes can be understood if explained, but the code should try to follow the global conventions as best as you can.
  • In case you do a change that should be documented in other places than the code (for example, the readme file), make sure that you are documenting it correctly.