Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (47 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

71 lines (47 loc) · 3.09 KB

Contributing to valkey-search

Welcome, and thank you for your interest in contributing!

Get started

Developer Certificate of Origin (DCO)

All commits must include a Signed-off-by line. This is how you certify that you authored the contribution and have the right to submit it under the project's license.

Add it automatically with the -s flag:

git commit -s -m "your commit message"

A signed commit looks like:

Signed-off-by: Jane Smith <jane@example.com>

PRs with unsigned commits will be blocked by the DCO check.

How to contribute

  1. For significant changes, open an issue first to discuss the approach before writing code.
  2. Fork the repository and create a topic branch off main.
  3. Make your changes and commit with a DCO sign-off (git commit -s).
  4. Push your branch and open a pull request against valkey-io/valkey-search:main.
  5. Address any CI failures and review feedback. All CI checks must pass before merging.

To link your PR to an existing issue, include Fixes #<issue-number> or Resolves #<issue-number> in the PR description.

Finding issues to work on

  • Issues labeled good first issue are explicitly flagged as good entry points for new contributors.
  • Issues labeled help wanted are higher-priority items where extra community involvement is welcome.
  • Before starting work on an issue, leave a comment expressing your intent — this avoids duplicate effort.

Slash commands

Collaborators can use the following commands in PR and issue comments to help do some trivial tasks.

Command Where What it does
/label <name> PR or issue Applies a label from the repo's defined label set. Rejects unknown labels; no-ops if already applied.
/reviewer <username> PR only Requests a review from the specified GitHub user. The user must be a repo collaborator.
/resolves <issue-number> PR only Appends Resolves #<N> to the PR body, linking the issue and auto-closing it on merge.
/rerun PR only Re-runs all failed or timed-out CI jobs for the PR's current head commit.

Example usage:

/label bug
/reviewer allenss-amazon
/resolves 925
/rerun

Code of conduct

This project follows the Valkey community code of conduct.

License

See LICENSE for the project's licensing. By contributing, you agree your contributions will be licensed under the same terms.