docs: add required examples #143
Conversation
| - Every example SHOULD follow a consistent layout and framing. | ||
|
|
||
| - ex: Consistent function name and input parameters across examples. |
There was a problem hiding this comment.
This is fine since it's a SHOULD, but I definitely expect different implementations to have language-specific naming and (potentially) a different number of parameters for specific operations.
There was a problem hiding this comment.
Yup. My intention there was to avoid requiring the same pattern across implementations but to encourage each implementation to be internally consistent.
| - [Python (DEV)](https://github.com/aws/aws-encryption-sdk-python/blob/keyring/examples/) | ||
| - [Java (DEV)](https://github.com/aws/aws-encryption-sdk-java/blob/keyring/src/examples/) |
There was a problem hiding this comment.
That's meant to leave a breadcrumb for the existing implementations but explicitly remind us that they're not in master yet.
|
If there are no objections, I think that introducing additional templates for specific examples fits best as a separate PR. |
| | Python | [aws-encryption-sdk-c](https://github.com/aws/aws-encryption-sdk-python) | | ||
| | Java | [aws-encryption-sdk-javascript](https://github.com/aws/aws-encryption-sdk-java) | |
There was a problem hiding this comment.
Link text should be "aws-encryption-sdk-python" and "aws-encryption-sdk-java" here?
| - If an example MUST contain logic that is not reasonable for production use, | ||
| it MUST include clear comments identifying that logic as such | ||
| and instructing the reader what they SHOULD do instead. |
There was a problem hiding this comment.
Should the comments also identify the reason that the logic is not reasonable for production use?
| Each implementation MUST include all examples | ||
| in its continuous integration testing. |
Issue #, if available:
#103
Description of changes:
This initial commit only contains the requirements for examples. Either through expanding this PR or via a separate PR, I'll be adding spec documents for each of the required examples.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.