CONTRIBUTING.md

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.

Table of Contents

• Reporting Bugs/Feature Requests
• Contributing via Pull Requests
  • Best Practices
  • Getting Started
    • Linting/Formatting
    • Testing
• Finding Contributions to Work On
• Code of Conduct
• Security Issue Notifications
• Licensing

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.

Best practices

1. Fork the repository.
2. Commit to your fork using clear commit messages that follow the Conventional Commits specification.
3. Ensure that linting, formatting and tests are are passing prior to raising the pull request.
4. If you are introducing new functionality, please commit the appropriate unit tests.
5. Answer 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.
7. Update CHANGELOG.md with any noteable changes you make. Be sure to add these changes under Unreleased.

Getting Started

We recommend installing the package locally in editable mode for ease of development. To install the package in editable mode along with the development depedencies, run the following:

pip install -e ".[dev]"

Linting/Formatting

The tools below are used for linting and formatting the codebase.

• Flake8
• Black
• isort

To check for linting and formatting issues, you can run the following:

flake8 src/ &&  black --check src/ && isort src/ --check --diff

Testing

This project uses pytest for unit testing, which you can invoke using the following:

python -m pytest .

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, looking for any issues labeled good first issue or help wanted 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 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.