zephyr icon indicating copy to clipboard operation
zephyr copied to clipboard

docs: add definition and minimum criteria for samples

Open aasthagr opened this issue 2 years ago • 0 comments

Adding guidelines for writing samples which includes definition and minimum criteria to quality as a sample.

Signed-off-by: Aastha Grover [email protected]

aasthagr avatar Jul 18 '22 21:07 aasthagr

@nashif I have updated this PR with the requested changes. Please re-review and let me know any further feedback. Thanks!!

aasthagr avatar Aug 10 '22 21:08 aasthagr

@microbuilder Thanks for reviewing this PR thoroughly. I have submitted few changes and left comments where needed :) Please re-review and let me know if any further improvisation is required.

aasthagr avatar Aug 26 '22 23:08 aasthagr

We should see about referring to a specific sample in the tree that shows best practices as documented here that people can use to copy from as a starting point.

@galak Have added a sample towards the end to use it as a reference.

aasthagr avatar Sep 09 '22 05:09 aasthagr

@aasthagr I think the overall changes in this PR make for a nice addition to the documentation. Do you think you can address the issues raised in time to get them into v3.2?

henrikbrixandersen avatar Sep 12 '22 20:09 henrikbrixandersen

@aasthagr I think the overall changes in this PR make for a nice addition to the documentation. Do you think you can address the issues raised in time to get them into v3.2?

@henrikbrixandersen Missed the 3.2 RC1, maybe it can still make it to 3.2 as RC2 is 09/16. I have updated this PR as per the requested changes. You may re-review again now. Thanks!!

aasthagr avatar Sep 13 '22 17:09 aasthagr

@aasthagr I think the overall changes in this PR make for a nice addition to the documentation. Do you think you can address the issues raised in time to get them into v3.2?

@henrikbrixandersen Missed the 3.2 RC1, maybe it can still make it to 3.2 as RC2 is 09/16. I have updated this PR as per the requested changes. You may re-review again now. Thanks!!

This is a documentation change, so I believe it can still be merged in for 3.2

microbuilder avatar Sep 13 '22 18:09 microbuilder