Contributing to SIMATIC AX Community

Welcome, and thank you for your interest in the SIMATIC AX Community

There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide an overview of how you can get involved.

Table of contents

• Thank you note
• Types of contributions
  • Discussions
  • Reporting issues
  • Pull requests
  • Contributing new repositories

Thank You

Your contributions to this open source project - large or small - let´s us create better automation solutions - together! Thank you for being an essential part of this journey.

Types of contributions

Discussions

Discussions are project wide and work like a typical forum.

Here you can post:

• questions
• answers
• feedback
• (topic) suggestions
• etc

regarding the product or community.

Please use SIMATIC AX Discussions

It should look like this:

1. Open GitHub discussion

2. Select a category

   

3. Submit your question, feedback or idea

Reporting issues

Issues are repository specific and like bug reports for the content of the repository.

• Is your library or application example not working as described?
• Do you have a feature request or an idea?

Feel free to report an issue direct in the related repository.

1. Select the related repository

2. Create a new issue

   

3. Select one of the provided issue types

   

Proposing content changes to individual repositories

Within the SIMATIC AX GitHub community we're following the standard process of forking a repository, in order to receive and integrate changes in our code base.

Please see the pull request process for more detailed information.

Contributing New Repositories

Non-Siemens employees

If you want to provide a completely new repository to the community, you will need to follow a special process, similar to internal contributors, because of certain legal and organizational procedures:

• Clearly state the repository’s purpose, scope, and intended use.
• Prepare the contents and ensure they comply with the community guidelines described below.
• Reach out to the Team of AXion. The administrators will initiate necessary legal checks for your content (OSS, IP, and ECC clearings).
• The admins will support you and perform these mandatory checks since external contributors cannot execute these clearings independently.

Once all clearings are successful, our admins will create the repository within the community, upload the content, and grant the appropriate permissions.

Siemens employees

In case you are a Siemens employee who likes to propose a new repository for the GitHub community, please read the Siemens contribution process for a set of follow along instructions.

For all inquiries, please get in touch via our Admin Team.