PredixSDK

The source repository that is used to build the Predix SDK for iOS. The SDK currently supports iOS and macOS.

Contribution guidelines

1. Branch or Fork the repo from develop.

2. Once the work is complete create a pull request to merge into develop. Once the pull request is created the following items must be satisfied to merge the pull request.

   1. All code additions/changes must be accompanied by unit tests.
   2. Test coverage must be at least 90% however, if no network calls or threads are involved it is preferred that test coverage is close to 100%
   3. Tests SHOULD NEVER rely on live network request/responses, if you need to test a section of code that is making a network requests please use the MockNetworkDataManager to mock the network request and response.
   4. All public APIs must contain in code documentation that is compatible with Jazzy code documentation output. New classes should contain examples of how the class is intended to be used within the code documentation.
   5. All Swift Lint checks must be satisfied.
   6. All public API additions or changes must be reviewed by Apple (Please contact an SDK team member for instruction for how to do this).
   7. If a new feature is being added the feature must contain wiki documentation and a How-to or Getting-Started guide for the feature. Please see examples by visiting the wiki documentation site.
   8. All pull requests must be code reviewed and approved by a member of the SDK team. Reviewers are also responsible for reviewing documentation that is going to be put into the Wiki (if required).
   9. Once approved the pull request will be allowed to merge with develop. It is the responsibility of the pull request initiator to merge their pull request with develop.
   10. Once the PR is merged the branch for the pull request should be deleted in Github (branches deleted in Github can always be recovered if needed).

This process is required by all contributors, inside of or outside of the Predix SDK for iOS team without exception.