Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
223 lines (153 loc) · 6.14 KB

CONTRIBUTING.md

File metadata and controls

223 lines (153 loc) · 6.14 KB

Contributing to Valkey Operator

Thank you for your interest in contributing to the Valkey Operator! We welcome contributions from the community.

Getting Started

Prerequisites

  • Go 1.24.0+
  • Docker 17.03+
  • kubectl v1.11.3+
  • Access to a Kubernetes cluster (kind, minikube, or cloud provider)

Development Setup

See the Developer Guide for detailed setup instructions.

Quick start:

# Clone the repository
git clone https://github.com/valkey-io/valkey-operator.git
cd valkey-operator

# Install dependencies
make generate
make manifests

# Run tests
make test

# Run the operator locally
make install
make run

How to Contribute

Reporting Bugs

Found a bug? Please open an issue.

Suggesting Features

Have an idea? Start a discussion in GitHub Discussions under the "Ideas" category. This helps gather community feedback before opening an issue or PR.

Submitting Pull Requests

  1. Fork the repository and create a branch from main
  2. Make your changes following our coding standards (below)
  3. Add tests for new functionality
  4. Run tests and linting: make test lint
  5. Update documentation if needed
  6. Commit with clear messages describing what and why
  7. Open a Pull Request with a clear description

We'll review your PR as soon as possible. Be patient and responsive to feedback.

Developer Certificate of Origin (DCO)

This project requires all contributors to sign off on their commits, certifying that you have the right to submit the code under the project's license.

By signing off, you agree to the Developer Certificate of Origin (DCO):

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

How to Sign Off

Add a Signed-off-by line to your commit messages:

git commit -s -m "Add new feature"

The -s flag automatically adds the sign-off line with your name and email:

Add new feature

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

Signing Off Previous Commits

If you forgot to sign off your commits, you can amend them:

# For the last commit
git commit --amend --signoff

# For multiple commits (interactive rebase)
git rebase -i HEAD~N  # where N is the number of commits
# Mark commits as 'edit', then for each:
git commit --amend --signoff
git rebase --continue

Important: All commits in a PR must be signed off. PRs without sign-offs will not be merged.

Coding Standards

  • Follow standard Go conventions and idiomatic Go code
  • Run go fmt before committing (or use make fmt)
  • Add comments for exported functions and types
  • Write unit tests for new code
  • Keep PRs focused - one feature/fix per PR
  • Update CRDs by modifying api/v1alpha1/*_types.go then run make manifests generate

Project Structure

valkey-operator/
├── api/v1alpha1/          # CRD definitions
├── cmd/                   # Main application entry point
├── config/                # Kubernetes manifests and Kustomize configs
├── internal/controller/   # Controller reconciliation logic
├── docs/                  # Documentation
└── test/                  # E2E and integration tests

Testing

# Run unit tests
make test

# Run E2E tests (requires cluster)
make test-e2e

# Run specific tests
go test ./internal/controller/... -v

Making Changes to the API

If you need to modify the ValkeyCluster CRD:

  1. Edit api/v1alpha1/valkeycluster_types.go
  2. Add kubebuilder markers for validation and defaults
  3. Regenerate manifests: make manifests generate
  4. Update the sample CR in config/samples/
  5. Test with make install to apply the updated CRD

Development Workflow

# 1. Make code changes
vim internal/controller/valkeycluster_controller.go

# 2. Update generated code and manifests
make generate manifests

# 3. Run tests
make test

# 4. Test locally
make install    # Install CRDs
make run        # Run controller locally

# 5. Build and test container
make docker-build IMG=valkey-operator:dev
make deploy IMG=valkey-operator:dev

Code Review Process

  • All submissions require review from maintainers
  • We may ask for changes or improvements
  • Once approved, a maintainer will merge your PR
  • PRs should pass all CI checks before merging

Questions?

Code of Conduct

Be respectful, inclusive, and constructive. We're all here to build something great together.

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

Thank you for contributing to Valkey Operator! 🙌