Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (46 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

78 lines (46 loc) · 3.76 KB

Contributing to 4diac IDE

Thanks for your interest in this project.

Eclipse 4diac is an 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 Industry 4.0 and industrial IoT applications.

What is 4diac IDE

4diac IDE is an extensible, IEC 61499 compliant engineering environment for distributed control applications. The modeled applications can be downloaded to distributed field devices according the means defined by the IEC 61499 standard. The hardware capability definition allows to model the control hardware and its interconnections through networks. The 4diac IDE is based on the Eclipse framework, which allows an easy integration of other plug-ins to the 4diac IDE providing new or extended functionality.

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

To build and develop the 4diac IDE you need:

  • Java 21 or newer
  • Eclipse IDE (Eclipse IDE for Java and DSL Developers edition recommended)

Additional Eclipse plugins (should be included in the Eclipse IDE for Java and DSL Developers):

  • M2E – Maven Integration for Eclipse
  • M2E – PDE Integration
  • Xtext Complete SDK

A detailed description of setting up a 4diac IDE development environment and running 4diac IDE from source can be found in our development documentation

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: