-
Notifications
You must be signed in to change notification settings - Fork 5.7k
README templates
The READMEs for this repo are required to use a specific format.
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.
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.
This README lists all the individual cross-service examples for a given AWS SDK language.
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!
- About the AWS SDK Code Examples repo
- Code quality guidelines - testing and linting
- Code comment guidelines
- Sample files guidelines
- Cross-service example guidelines
- README templates
-
Code example standards
- General standards
- .NET code example standards
- C++ code example standards
- CLI/Bash code example standards
- Go code example standards
- Kotlin code example standards
- Java code example standards
- JavaScript code example standards
- PHP code example standards
- Python code example standards
- Swift code example standards
- SAP-ABAP code example standards
- Ruby code example standards
- Rust code example standards