Skip to content

Latest commit

 

History

History
78 lines (46 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

78 lines (46 loc) · 3.36 KB

How to contribute to BaSyx

Thanks for your interest in this project.

Project description

Eclipse BaSyx collects the implementation results of the research project BaSys 4.0. An essential goal of BaSys 4.0 is the use of IT technology for production systems to enable the concepts of the new Industrie 4.0 paradigm. It develops a middleware that integrates traditional production systems (e.g. PLC controllers) and state-of-the art IT technology (BPMN engine, SOA) to enable next generation of production automation.

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability in BaSyx, and instead refer to our security policy.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a BaSyx configuration including relevant AAS files (AASX, JSON, XML) for reproducing the issue.

  • If possible, use the relevant bug report templates to create the issue.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

  • Before submitting, please read the Contributing to BaSyx guide to know more about coding conventions.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of BaSyx will generally not be accepted.

Do you intend to add a new feature or change an existing one?

  • Suggest your change using the feature request template when opening a new issue.

  • Do not open a pull request until you have collected positive feedback about the change.

Eclipse Development Process

This Eclipse Foundation open project is governed by the Eclipse Foundation Development Process and operates under the terms of the Eclipse IP Policy.

Eclipse Contributor Agreement

Before your contribution can be accepted by the project team contributors must electronically sign the Eclipse Contributor Agreement (ECA).

Commits that are provided by non-committers must have a Signed-off-by field in the footer indicating that the author is aware of the terms by which the contribution has been provided to the project. The non-committer must additionally have an Eclipse Foundation account and must have a signed Eclipse Contributor Agreement (ECA) on file.

For more information, please see the Eclipse Committer Handbook: https://www.eclipse.org/projects/handbook/#resources-commit

Contact

Contact the project developers via the project's "dev" list.

Do you want to contribute to the BaSyx documentation?

  • Please go to the basyx-wiki repository and create a PR there.

Thanks! ❤️ ❤️ ❤️

The BaSyx Team