We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
Reporting a bug
Discussing the current state of the code
Submitting a fix
Proposing new features
Becoming a maintainer
We Develop with CODESYS Forge
We use CODESYS Forge to host code, to track issues & feature requests.
Since CODESYS IDE is currently only using SVN, Pull Requests (PR's) are a bit of an issue currently.
Every code should be checked before submission:
Does your code have a test in the verifier?
No => write a test for the verifier
Yes => provide proof that your code and test works
After peer review and a working unittest in the verifier is provided, the code is eligible for merge in the trunk.
Any contributions you make will be under the MIT Software License
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project.
Feel free to contact the maintainers if that's a concern.
Report bugs using Codeys Forge [Tickets]
We use Tickets to track public bugs. Report a bug by opening a new ticket; it's that easy!
Write bug reports with detail, background, and sample code
Great Bug Reports tend to have:
A quick summary and/or background
Steps to reproduce
Be specific!
Give sample code if you can.
What you expected would happen
What actually happens
Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
Use a Consistent Coding Style
Never open/edit the trunk code! Instead, create a (local) branch under your own name and make your code adjustmensts there.
Make sure to keep the library settings and project information as the trunk project, except your version number.
Make sure that your CODESYS IDE uses spaces instead of tabs. The default behaviour of the CODESYS IDE is to use tabs so it needs to be changed. See Tools - Options - Text Editor - Editing - Untick "Keep tabs" and set tabwidth to 4
License
By contributing, you agree that your contributions will be licensed under its MIT License.