Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rust: Document lint and static checks. #5998

Merged
merged 1 commit into from
Jan 26, 2024
+5 −0
Merged

Rust: Document lint and static checks. #5998

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions rustv1/README.md
View file
Open in desktop
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
Loading