Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (44 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

73 lines (44 loc) · 3.17 KB
Raw

Contributing to Eclipse 4diac Documentation

Thanks for your interest in this project.

Project Description

Eclipse 4diac is a Open Source Framework for Industrial Automation & Control. It is a reference implementation for the IEC 61499 standard. IEC 61499 defines a domain specific modeling language for developing distributed industrial control solutions. IEC 61499 extends IEC 61131-3 by improving the encapsulation of software components for increased re-usability, providing a vendor independent format, and simplifying support for controller-to-controller communication. Its distribution functionality and the inherent support for dynamic reconfiguration provide the required infrastructure for Industrie 4.0 and industrial IoT applications.

Terms of Use

This repository is subject to the Terms of Use of the Eclipse Foundation.

Ways to Contribute

Contributions are welcome in many forms including:

  • bug reports and issue reproduction
  • code contributions
  • documentation improvements
  • usability and UI improvements
  • testing and validation

See the Eclipse 4diac contribute page for details.

Contribution Guide

The development workflow, pull request process, commit guidelines, and testing expectations are described in the Eclipse 4diac contribution guide

Development Environment

The Eclipse 4diac documentation is written using AsciiDoc. AsciiDoc is a lightweight markup language. The Eclipse 4diac documentation can therefore be edited with any text editor or directly in Github.

In order to preview the output you need:

  • Asciidoctor
  • Maven

To generate the output run mvn in the root directory of this repository. The resulting documentation can be found in the target directory.

Eclipse Development Process

This project operates under the Eclipse Foundation development process and IP policy.

Eclipse Contributor Agreement

Before your contribution can be accepted you must sign the Eclipse Contributor Agreement (ECA)

The ECA provides the Eclipse Foundation with a permanent record that you agree that each of your contributions will comply with the commitments documented in the Developer Certificate of Origin (DCO). Having an ECA on file associated with the email address matching the "Author" field of your contribution's Git commits fulfills the DCO's requirement that you sign-off on your contributions.

For more information, please see the Eclipse Committer Handbook

Ensure that:

  • the email in your Git commits matches your Eclipse account
  • your GitHub username is linked to your Eclipse account

Contact

Project discussions take place via: