Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 3.04 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.
  • 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. 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. Ensure you have Node.js and NPM installed, then run npm install to install development dependencies.
  3. Modify the source; please focus on the specific change you are contributing.
  4. Run npm run all. This will run tests and build dist/index.js (the actual entry point of the GitHub Action).
  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. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

Finding Contributions to Work On

Looking at the existing issues is a great way to find something to contribute on.

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 Disclosures

If you would like to report a potential security issue in this project, please do not create a GitHub issue. Instead, please follow the instructions here or email AWS Security directly.

Licensing

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