Skip to content

README templates

Jump to bottom
ford prior edited this page Jul 22, 2022 · 16 revisions

The READMEs for this repo are required to use a specific format.

  1. Service level folder README template

Customers in an AWS service guide or AWS SDK guide are directed to this README if they choose the GitHub link from a single action or scenario code example, such as Create an Amazon SNS topic using an AWS SDK. This README is designed to help customers scan the contents, grasp the context, and understand how to find and run examples.

  1. Language level folder README template

Customers in an AWS service guide are directed to this README if they choose the GitHub link from a top-level SDK information topic, such as Using Amazon SNS with an AWS SDK. This README provides customers with introductory information about the code examples for a given AWS SDK language.

  1. Cross service level folder README template

This README lists all the individual cross-service examples for a given AWS SDK language.

  1. Single cross-service example README template

Customers in an AWS service guide or SDK guide are directed to this README if they choose the GitHub link from a cross-service code example, such as Build a publish and subscription application that translates messages. This README is designed to help customers find and run examples.

In the spirit of templating and consistency, here are the templates for our Scrum ceremonies!

  1. Sprint Demo agenda
  2. Sprint Planning agenda
  3. Sprint Retro agenda
Clone this wiki locally