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.

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 changes before starting the 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 local tests pass.
4. Commit to your fork using clear commit messages, merge or squash commits as necessary.
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.

Commit Requirements

Developer Certificate of Origin (DCO) Signoff

All commits MUST include a DCO signoff to certify authorship and license compliance. Pull requests are checked for proper signoffs, and commits without them are rejected.

• Required signoff line (must appear at the end of every commit message):

  Signed-off-by: Your Name <your.email@example.com>
  

• How to add signoffs:

  • Automatic (recommended): git commit -s -m "<message>"
  • Configure Git to always sign off: git config --global format.signOff true
  • Amend last commit to add signoff: git commit --amend --signoff --no-edit
  • Multiple commits missing signoffs: git rebase -i HEAD~n --signoff

Conventional Commit Format

Use Conventional Commits for commit messages (this applies to commit messages only — use clear, descriptive English for pull request and issue titles).

Example:

feat(config): add ReadFrom parsing support

- Implement ParseReadFromStrategy method
- Add validation for ReadFrom strategy and AZ parameter combinations

Addresses GitHub issue #26

Signed-off-by: Your Name <your.email@example.com>

Finding Contributions to Work On

Looking at the existing issues is a great way to find something to contribute on. Issues with the 'help wanted' label are 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

Reporting a Vulnerability

Licensing

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

Community Support and Feedback

We encourage you to join our community to support, share feedback, and ask questions. You can approach us for anything on our Valkey Slack: Join Valkey Slack.