Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 4.67 KB

CONTRIBUTING.md

File metadata and controls

90 lines (57 loc) · 4.67 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project. 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 issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Feature Requests

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

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 are incredibly useful:

  • A reproducible test case or series of steps
  • Any details of your application environment that may be relevant. At minimum, this should include the Smithy version, JRE version, and operating system.
  • Any modifications you've made relevant to the bug

Contributing via Pull Requests

Contributions via pull requests are much appreciated. 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.
  3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

To send us a pull request, please:

  1. Fork the repository.
  2. Modify the source; please focus on the specific change you are contributing and refrain from modifying unrelated code or reformatting code.
  3. Follow the same coding style as the rest of the project.
  4. Add new test cases that exercise the change and covers all non-trivial branches.
  5. Ensure that running ./gradlew clean build completes successfully.
  6. Write a changelog entry using ./changes/new-change.
  7. Commit to your fork using clear commit messages by following the guidance at How to Write a Git Commit Message.
  8. Send us a pull request, answering any default questions in the pull request interface.
  9. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

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

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

Testing with AWS SDK code generators

In the past, Smithy changes have been released without integration testing with Smithy-based SDK code generators. In addition, SDK code generators often fall behind in Smithy versions. As a result, we don’t have visibility on code generators’ failures until they are upgraded to the latest smithy version.

The GitHub action sdk-codegen-ci.yml builds and test Smithy-based AWS SDKs using the latest Smithy implementation.

The GitHub action can be triggered manually via Run workflow in the Actions tab of the Smithy repo. (See Manually running a workflow for step-by-step instructions)

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.

Please use the following license header in new code files:

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */