Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (58 loc) · 5.62 KB

CONTRIBUTING.md

File metadata and controls

89 lines (58 loc) · 5.62 KB

Contributing Guidelines

Thank you for your interest in contributing to the AWS SDK for Rust! Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any contributions to ensure your contribution goes to the correct code repository and we have all the necessary information to effectively respond to your request.

The AWS SDK for Rust has three GitHub repositories

  1. This repository (awslabs/aws-sdk-rust)

    This repository contains code generated from awslabs/smithy-rs. If you want to contribute to the SDK by submitting feedback to our roadmap or filing a bug report, you can do so using this GitHub repository. However, because this repository is code generated from Smithy models, please do not submit PRs modifying code or examples to this repository.

  2. Examples repository (awsdocs/aws-doc-sdk-examples)

    All the SDK code examples are in the rustv1 directory of aws-doc-sdk-examples. They are automatically copied over to aws-sdk-rust when a new release is cut. Please make example contributions there, and be sure to take a look at its CONTRIBUTING.md.

  3. Smithy-based SDK generation repo (awslabs/smithy-rs)

    If you want to contribute by diving into the codegen machinery and helping develop the SDK, please navigate to the Smithy code gen machinery repo. Here you'll be able to see all the ins-and-outs of the code generator. We welcome PRs and other contributions to this repository, but please make sure to review its CONTRIBUTING.MD

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features to this code repository.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these for bug reports are incredibly useful:

  • A reproducible test case or series of steps
  • The version of our code being used
  • Any modifications you've made relevant to the bug
  • Anything unusual about your environment or deployment

Contributing via Pull Requests

Contributions via pull requests are much appreciated, however, because all of the code on this repository has been code generated from the smithy-rs, please do not submit PRs modifying the sdk folder to this repo. The below instructions are for PR that do not update code, such as documentation changes.

Before sending us a pull request, please ensure that:

  1. You are working against the latest source on the main branch.
  2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.

To send us a pull request, please:

  1. Fork the repository.
  2. Modify the source; please focus on the specific change you are contributing.
  3. Commit to your fork using clear commit messages.
  4. Send us a pull request, answering any default questions in the pull request interface.

GitHub provides additional document on forking a repository and creating a pull request.

Building High Level Libraries

This is one of the best ways to contribute to the SDK. Looking for an open issue labeled 'help wanted' is a great way to find one that we could use your help with. Please comment on the issue to communicate your interest so we can work with you in its development.

Automated Tools

The use of AI tooling for assisted development work is accepted and encouraged in this repository, but due to the volume of submissions we ask that you observe the following rules:

  • All issue and pull request submissions to this repository that are sourced by AI must first be reviewed by a human before submitting to the repository. Items reviewed in this way must include a statement like "generated by AI tools, and reviewed by "
  • Please ensure that your submissions are actually improvements. While we are grateful for any proposed fixes, even if they are very small, behavior that looks like creating nuisance PRs or artificially inflating submission counts is not acceptable.
  • We may close issues or pull requests, or limit your ability to interact with this repository, for behavior that in our estimation violates these rules or any of the other rules in this repository's Code of Conduct

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opensource-codeofconduct@amazon.com with any additional questions or comments.

Security issue notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.
⚡