awslabs / awslabs/aws-encryption-sdk-specification

add "required examples" specification

Open
#103 1 comment 0 reactions 1 assignee Claimed by @mattsb42-aws View on GitHub
Dominant language
JavaScript
Stars
37
Forks
27
PR merge metrics
No merged PRs in 30d

Description

Add a specification doc that details the required examples, as laid out here[1].

Things we need to define include:

* The examples readme structure.
* This is the structure and content laid out here[1].
* The list of all example scenarios.
* This is the complete list of examples defined here[1].
* Requirements for any given example.
* Every example MUST be independent.
* Every example MUST NOT require additional or prior knowledge to understand.
* Every example MUST explain step by step what it is doing.
* Those explanations MUST differentiate between things that we are recommending that customers do vs things that we are demonstrating to customers.

[1] https://github.com/aws/aws-encryption-sdk-python/tree/master/examples

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.