Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 5.09 KB

CONTRIBUTING.md

File metadata and controls

81 lines (53 loc) · 5.09 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to Mountpoint for Amazon S3. 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

Please 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

Logs are also valuable for bug reports. Please read the logging documentation for details on how to capture verbose logs.

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. Modify the source. Please focus on the specific change you are contributing; we value multiple small pull requests that are easier to review.
  3. Ensure local tests pass.
  4. Commit to your fork using clear commit messages.
  5. Send us a pull request, answering the 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.

We require all contributors to agree to the terms of the Developer Certificate of Origin (DCO), and to indicate this agreement by signing their commits using Git's Signed-off-by support. To add this trailer to your commits, use the -s, --sign-off option to git commit.

Pull request title and description

The pull request title and description is there to describe the change - both what is changing and why.

It is important to address each section of the pull request template, and additionally to keep it maintained. The title and description will be used at merge time to create the squash commit message on the base branch (usually main). Keeping them both up-to-date as the code change evolves ensures that the commit message is useful for future readers.

Changelog updates

New features, bug fixes, or changes in behavior often justify a note in the CHANGELOG.md file for the relevant crate.

The main Mountpoint changelog lives in the mountpoint-s3 crate/directory, but we also maintain changelog entries for each of the crates that are published to crates.io.

Here is the full list of changelog files we maintain for reference.

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. We use issue labels to identify good first issues as 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 Security via our vulnerability reporting page. Please do not create a public GitHub issue.

Licensing

Mountpoint for Amazon S3 is licensed under the Apache-2.0 license. The pull request template will ask you to confirm the licensing of your contribution and to agree to the Developer Certificate of Origin (DCO).