Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 1.45 KB
Raw

How to contribute

Patches/Pull-requests are always welcome

Getting Started

  • Make sure you have a GitHub account
  • Submit a ticket for your issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
  • Fork the repository on GitHub

Submitting Changes

  • Submit a pull request to the repository in the s7-connector organization.

Project structure

Documentation

The documentation is written in the gh-pages branch as a tiddlywiki. Use the editmode tab on the right to enable additional buttons. After editing you can save the wiki with your browser.

Packages

The main package is com.github.s7connector

Sub-packages:

  • api for interfaces and common classes, should be the main entry point for users
  • blocks Existing Data-blocks with annotations for serialization to/from the PLC
  • exception Specific S7Exceptions
  • impl Implementation classes

Additional Resources