Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (43 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

60 lines (43 loc) · 2.54 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to this 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 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 and 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 useful:

  • A reproducible test case or series of steps
  • The version of our code being used
  • Any modifications you have made relevant to the bug
  • Anything unusual about your environment or deployment (OS, GPU, cloud provider)

Contributing via Pull Requests

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

  1. Fork the repository.
  2. Modify the source, focusing on the specific change you are contributing.
  3. Verify that shell scripts pass bash -n syntax check.
  4. Verify that Python files pass python3 -m py_compile.
  5. Commit to your fork using clear commit messages.
  6. Send us a pull request, answering any default questions in the pull request interface.
  7. Stay involved in the conversation and address any CI feedback.

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, please notify AWS/Amazon Security via our vulnerability reporting page. Do not create a public GitHub issue.

Licensing

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