How To Submit Additions and Changes

[This is preliminary documentation and is subject to change.]

The CFX Standard and the CFX SDK continue to grow and evolve via the contributions of the CFX community, under the direction and oversight of the IPC. All CFX message structures, and functions of the CFX SDK are maintained on GitHub as an open source project that is open and available to all. Members of the IPC Connected Factory Exchange Committee (2-17) may submit requests to change or augment the CFX message structures and SDK capabilities via the GitHub site. These requests are then reviewed by the IPC, and once approved, merged into the next publication of the CFX Standard.

This guide explains the process for submitting these change requests via GitHub. In order to submit requests, you must have a GitHub account, and be a member of the GitHub CFX team. Any member of the IPC 2-17 Connected Factory Exchange Committee is eligible to become a member of the GitHub CFX team. To join, email Nancy Jaster of the IPC at NancyJaster@ipc.org

Submission Process Overview

Here is an overview of the process you should follow to submit a request to change/augment the CFX message structure and/or SDK:

Log into the CFX GitHub site (https://github.com/IPCConnectedFactoryExchange/CFX) using your GitHub credentials (you should already by a member of the GitHub CFX team).
Create your own branch from the “master” branch.
Make your new additions / edit existing content.
Commit all of your changes to your personal branch.
Submit a “Pull Request” to the IPC through the GitHub environment.
A member of the IPC CFX “Software Power Team” will review your request, including all of your proposed changes.
If approved, your changes will be automatically merged with the “master” branch, and become publicly available to all. Your changes will then be included in the next formal Publication of or Addendum to the CFX Standard.
If your changes are not immediately approved, additional information, conversation, and / or modifications may be required. You will be directly contacted in this case.

Additional details on performing these basic functions on GitHub can be found here:

https://guides.github.com/activities/hello-world/

Guidelines on Submissions

Here is an overview of the process you should follow to submit a request to change/augment the CFX message structure and/or SDK:

All changes and additions to CFX must be fully documented in English using XML Code Documentation Comment system described at: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments
• Message and data property names should be consistent with the naming conventions of the existing messages (Pascal Case, Verb Tense, etc.).