Thank you for considering contributing to this project. This document will help you to get started and guide you through the process. Industrial automation has developed very limited culture of open-souce development. The most important is to get started and enjoy the wave of endorfins once your pull request is approved. It does not have to be anything big, maybe just typo in the documentation, question or idea to discuss.
When contributing to this repository, please first discuss the change you wish to make via issue or open a discussion.
IMPORTANT!!! If you discover a security issue do not disclose that information in public spaces of the repo (issues, discussions), more info here.
- Your contributions are under MIT license.
- Make sure you work with tools and versions listed in the pre-requisites.
- Use consistent coding style, find more info in coding style document of this project.
- All changes happen via pull requests.
- Additions or changes to the code should contain in-code documentation .
- Additions or changes should be reflected in how-to and readme documentation.
- Addition or changes should contain unit tests that reliably cover the changes or additions.
- Ensure any install or build dependencies are removed before requesting approval.
- Describe the change in the PR use this template if applicable.
- Pull requests will be reviewed and merged by repository maintainers.