We are open to, and grateful for, any contributions made by the community. By contributing to this project, you agree to abide by the code of conduct.
Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.
We use the issue tracker to keep track of bugs and improvements. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion.
This project is at a very initial stage. Help is needed in all areas, from UX to improvements in the deformation capabilities. Any other suggestions for features would be accepted as well.
- Fork the repository
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'add some feature') - Push to your branch (
git push origin my-new-feature) - Create a new Pull Request
- Please make sure to follow existing conventions and style in order to keep the code as readable as possible.
- Please make sure your changes did not break any functionalities.
- Please make sure to comment your changes.
- Please make sure to update the readme file if needed.
- Try to test for your changes as well.
Thanks you for contributing!