doc: overhaul sample criteria and expectations #78024
Conversation
nashif
force-pushed
the
topic/doc/samples_cri
branch
from
5947bf6
to
215ac36
Compare
| * Make the sample as generic as possible. Avoid making a sample platform specific unless it is | ||
| for particular hardware. | ||
|
|
||
| 4. A sample should provide sufficient coverage of a subsystem, feature, or module. | ||
| 3. A sample should provide sufficient coverage of a subsystem, feature, or module. |
There was a problem hiding this comment.
FWIW I have mixed feelings about this section as it contains a lot of redundant information (if we people don't get it by now that samples must not be unit tests!) and the wording might be confusing: we ask for "sufficient coverage of a subsytesm" when earlier we advise to not use samples to test subsystems.
No immediate action needed though as it is OK enough as-is and can be improved in later PRs.
There was a problem hiding this comment.
coverage as in 'feature coverage', try to demonstrate as much as possible of a subsystem to be usable and submit thin content leaving much behind.
There was a problem hiding this comment.
yup, I know that's what this is supposed to mean, hence why I said I think it's confusing as other people not aware of the distinction between tests and samples that we're trying to establish might interpret "coverage" in a different way by just looking at the heading title.
Like I said, will likely tackle this in a follow-up PR but I guess where my head is at is rewording/summarizing this along the lines of "A sample should demonstrate an actual use case" or something in that vein.
overhaul sample criteria and what we expect in a sample, especially overhaul the twister part and what should be provided for good test coverage. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
nashif
force-pushed
the
topic/doc/samples_cri
branch
from
ce4994f
to
da29373
Compare
overhaul sample criteria and what we expect in a sample, especially
overhaul the twister part and what should be provided for good test
coverage.
Signed-off-by: Anas Nashif anas.nashif@intel.com