-
Notifications
You must be signed in to change notification settings - Fork 5.8k
README templates
Brian Murray edited this page Feb 17, 2022
·
16 revisions
The READMEs for this repo are required to use a specific format.
Customers in an AWS Service or SDK guide are directed to a service-level README if they choose the link to GitHub from a single action or scenario code example - for example from Create an Amazon SNS topic using an AWS SDK. The README is designed to enable customers to scan the contents and grasp the context, and understand how to find and run examples.
-
Language level folder README
-
Cross service level folder
-
Single cross service example
- 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
- CPP code example standards
- .NET 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
- Ruby code example standards
- Rust code example standards