Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

80 lines (51 loc) · 3.89 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.

Project Structure

For projects built on the demo repository we use a unique branching strategy. We pair this with composable docker-compose files to make core project updates simple.

  • Main: The main branch should only contain the top level documents such as: License, Code of Conduct, etc.
  • Basic: This branch should contain the files passed into the demo branches. It serves as the basis for all the demos.
└── main
    └── basic
        ├── kafka-opensearch
        │   ├── search-kafka
        │   ├── trace-kafka
        │   └── monitor-kafka
        └── opensearch-benchmark

As shown above, all demos are based off of the basic branch. From there, you can nest branches if they share functionality, as shown with the Kafka-OpenSearch demo.

For a more detailed guide on contributing to demos please see the DEVELOPER_GUIDE.

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 your current 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. Ensure demo is functional and repeatable.
  4. Commit to your fork using clear commit messages.
  5. Send us a pull request, answering any default questions in the pull request interface.

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 [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.