Skip to content

Commit

Permalink
Rust: Document lint and static checks.
Browse files Browse the repository at this point in the history
Closes $5997
  • Loading branch information
DavidSouther committed Jan 24, 2024
1 parent fda7e9d commit 7f7a9fa
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions rustv1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 7f7a9fa

Please sign in to comment.