Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If the WG approves, a repository in the edgexfoundry-holding project will be created, for the new service to be imported into. Once this is in place, a reviewer The WG will also seek volunteers to form a review group, who will consider the service for suitability . NB the WG will seek a reviewer before the holding repository is createdonce it is imported.

Other than general code quality, the review should consider:

  • The service should implement the functionality described in the Device Services Requirements document.
  • The service should target either the current or development versions of EdgeX.
  • The service should not rely on new or variant APIs.
  • The service's name should should follow the usual form, ie edgex-{device-class}-{language} and not conflict with any other adopted service.
  • Values must not be hardcoded where they might reasonably be configurable.
  • The following items must be documented:
    • Supported configuration options.
    • Supported ProtocolProperties schemes.
    • Supported Device Attributes.
  • As part of the above, example Device Profiles and illustrative TOML for Device provisioning should be included.
  • It must be possible to run the device service against simulated hardware. Documentation illustrating how to do so is also required.
  • The service should comply with the general EdgeX requirements as given in the Contributor's Guide.

...

  • The service code is moved from -holding to the main edgexfoundry project.
  • EdgeX documentation is updated to include the new service.
  • Required devops infrastructure is put into place.
  • Release artifacts for the first version should be generated and published.
  • Device WG wiki pages to be updated.

...