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 use github to host code, to track issues and feature requests, as well as accept pull requests.
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
master. - If you've changed APIs, include the API change in the Pull Request so that the official homepage can be updated.
- Link your Issue for that pull request!
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
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)
- Make sure to edit the project with the same version of Visual Studio as the master branch. All Twincat software has been developed using Visual Studio 2017 Shell. Note that VS2017 shell (provided with TwinCAT 3.1.4024.x) can't open the .net solution (as it's a .NET/C# project). Instead it's recommended to use VS2019 community edition.
- The prefixes of naming of function blocks/variables/etc from the Beckhoff TwinCAT3 identifier/name conventions
- Make sure to set your TwinCAT development environment to use Separate LineIDs. This is available in the TwinCAT XAE under Tools→Options→TwinCAT→PLC Environment→Write options→Separate LineIDs (set this to TRUE, more information is available here)
By contributing, you agree that your contributions will be licensed under its Apache 2.
This document was adapted from briandk's excellent contribution guidelines template.
Requirements
- VS2019
cd .\source\Log4Tc\
.\build.cake