Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (48 loc) · 4.23 KB

CONTRIBUTING.md

File metadata and controls

71 lines (48 loc) · 4.23 KB

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 so 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 verify 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. If you also reformat all the code, it will be hard for us to focus on your change.
  3. Confirm 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 document 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.

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.

Security Guidelines for Contributors

When contributing code to this project, please follow these security practices:

  • No hardcoded credentials — Do not commit AWS account IDs, access keys, secret keys, or session tokens. Use environment variables or config.py placeholders.
  • Run git-secrets — Install and run git-secrets before committing to prevent accidental credential leakage.
  • IAM least-privilege — Any new IAM policies must be scoped to specific resource ARNs. Do not use *FullAccess managed policies or Resource: "*" without justification.
  • No shell=True — Use subprocess.run() with shell=False and argument lists. Do not pass user-controlled strings to shell commands.
  • Dependency scanning — If adding new Python dependencies, verify they are from trusted sources and pin versions. Run pip audit or equivalent before submitting.
  • Input validation — Any new endpoints or data ingestion paths must validate input size, format, and schema before processing.
  • S3 security — New buckets must enable Block Public Access, server-side encryption, and TLS-only policies.

Licensing

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