Contributing Hints

1. Check the Issues list to see what you can help with. Alternatively one can find something to fix and create issue about it to discuss :)
2. If you don't know well how to use git and github, the simplest way is this:
   • click Fork to make your copy of repository
   • edit the file(s) you want (this could be done even via web-interface)
   • after you have saved the change create "Pull Request" (PR) in the main repository, make sure (by looking at difference of files) that you don't change anything unwanted
   • after some time there could be some comments with request to improve PR (by adding more changes to your copy)
   • if everything goes well, soon it is "merged" to main repository
   • now, if you don't know how to update your copy, delete it (you'll be able to create new fork from updated version when you want)
3. However it is strongly recommended to learn using git via command line and run the project locally to check your changes.
4. Try to make small changes!!!!! I.e. less than 20-30 lines in 1-2 files. There are several reasons:
   • small changes are easier to review and there is less chance you'll need improve them
   • there is less chance you get in conflict with someone creating another PR touching same pieces of code
5. Follow python style guides (hopefully we'll have automated checker soon). Check style by provided script ./docker/py-check.sh
6. Don't leave comments unless it is really necessary. Usually it's better to explain things by using clever variables and function names. Read a bit of Robert Martin's "Clean Code" on this.