edgexfoundry / edgexfoundry/device-modbus-go

Add .md pages describing how to test (with real hardware)

Open
#299 0 comments 1 reaction 0 assignees View on GitHub
documentation enhancement help wanted kamakura
Dominant language
Go
Stars
120
Forks
105
PR merge metrics
No merged PRs in 30d

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.

Contributor guide

Open the contributing guide

Research direction

Start by locating the device service documentation and the HOWTOTEST.md and WORKSWITH.md files requested by the issue. Document manual base-functionality checks using real hardware, then list tested devices with make, model, links, and acquisition details; done means both pages support release testing and hardware selection.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation, embedded-iot
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.