From 7f7a9fa6ddeb87c7fd5d700152f8296a2ed63de9 Mon Sep 17 00:00:00 2001 From: David Souther Date: Wed, 24 Jan 2024 16:11:23 -0500 Subject: [PATCH] Rust: Document lint and static checks. Closes $5997 --- rustv1/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/rustv1/README.md b/rustv1/README.md index 83d904940fa..769e8786cda 100644 --- a/rustv1/README.md +++ b/rustv1/README.md @@ -98,6 +98,11 @@ these examples in an isolated environment. ## Contributing +When adding or modifying Rust code examples, follow common Rust best practices. +As much as is reasonable, this means having tests that run with `cargo test`, code that has no lint errors from `cargo clippy --all-targets`, and code that has been formatted using `cargo fmt`. +These can be verified using cargo with in the example folders, or across the entire Rust code base with the `./run_all.sh` script. +The `run_all.sh` script is also used in continuous integration toolchains. + To propose a new code example to the AWS documentation team, see [CONTRIBUTING.md](https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/CONTRIBUTING.md). The team prefers to create code examples that show broad scenarios rather than individual API calls.