This project welcomes GitHub issues and pull requests!
Before submitting a pull request, be sure to:
- Run
cargo fmtto resolve any formatting issues. - Run
cargo clippyusing the minimum-supported Rust version (MSRV) and resolve any warnings. For example, if the MSRV is 1.70, runcargo +1.70.0 clippy(after installing that version usingrustup toolchain install 1.70.0). Running Clippy using a newer Rust version may emit warnings that depend on Rust features not yet stabilized in the MSRV. These will be addressed whenever the MSRV is updated (see the README for more information about the MSRV policy). - Run
cargo testto ensure that tests pass. When making changes that affect the generated code, the Insta snapshots may need to be updated. First, install Insta by runningcargo install cargo-insta. Then, update the test snapshots by running:Be sure to add the modified snapshot files to your pull request viacargo insta test --reviewgit add.
To run the Petstore example API integration tests locally:
- Install the AWS SAM CLI if you have not already done so.
- Run the following from the
examples/petstoredirectory to start the local API emulator:Please note that this requires thesam local start-apilocalhostTCP port 3000 to be available. - In a separate terminal, run the tests as follows:
cargo test -p petstore -- --ignored