-
Notifications
You must be signed in to change notification settings - Fork 5.7k
Sample files guidelines
Rachel Hagerman edited this page Dec 12, 2022
·
1 revision
Some of the code examples in this repository use sample files located in the Sample Files directory.
Files in this directory should be listed in the README, and should meet the standards for a shared sample file.
- Files must be created for this repository and not copied from other sources.
- Files should be reusable across multiple examples. Single-use files can be located in the code directory for their respective languages.
- Files that can be referenced elsewhere should be linked instead.
- Files should not exceed a size of 10 MB.
- Media files such as MP3 or WAV files should be located in the directory for sample media.
Note: Adding a file should be a last resort, after considering all other options such as generating the file in the code, allowing the user to specify their own file, or linking to a known source.
- 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