edgexfoundry / edgexfoundry/device-sdk-go
Add template .md pages describing how to test (with real hardware)
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 106
- Forks
- 136
- Avg merge
- 1h 36m
- Merged PRs (30d)
- 1
Description
Per Kamakura planning meeting (Nov 21), each device service should provide a HOWTOTEST.md page that describe how to check the base functionality of the device service with real hardware. These tests should be run manually before each release.
Each device service should also provide a WORKSWITH.md page that lists the actual hardware (make, model, web site link, etc.) that the device service has been tested with and known to work with. Provide enough details on the device/sensor so that an adopter would know where to go to get the same device.
The SDK should provide templates for these files.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the SDK's existing documentation and template conventions, then identify where HOWTOTEST.md and WORKSWITH.md templates belong. Done means the SDK provides both templates with guidance for manual real-hardware testing and recording tested device make, model, and web details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100