Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 3.07 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 and requesting features

Use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, check existing open and recently closed issues to make sure someone else hasn't already reported the issue. Try to include as much information as you can. Details like these 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 through pull requests

Contributions made through pull requests are much appreciated. Before sending us a pull request, 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:

  1. Fork the repository.
  2. Modify the source; focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
  3. Ensure local tests pass.
  4. Commit to your fork using clear commit messages.
  5. Send us a pull request, answering any default questions in the pull request interface.
  6. 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 ways to contribute

Looking at the existing issues is a great way to find something on which to contribute. 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.

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 [email protected] with any additional questions or comments.

Security issue notifications

If you discover a potential security issue in this project we ask that you notify 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.