OT-CONTAINER-KIT/redis-operator

Describe a complete list of software (and their version) required to contribute to this project in CONTRIBUTING.md

Open

#870 opened on Apr 12, 2024

View on GitHub
 (3 comments) (0 reactions) (1 assignee)Go (377 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (1,416 stars)
PR merge metrics
 (PR metrics pending)

Description

What version of redis operator are you using?

None yet (intending to work on HEAD of branch)

Does this issue reproduce with the latest release?

Yes.

What operating system and processor architecture are you using (kubectl version)?

Not relevant

What did you do?

  1. Tried to contribute by extending the tool (See https://github.com/OT-CONTAINER-KIT/redis-operator/issues/868).
  2. Realised that latest operator-sdk is not working, because this code is not ready for v4 (See https://github.com/OT-CONTAINER-KIT/redis-operator/issues/759)
  3. Check the contributing.md to find the appropriate operator-sdk, and see that no version is documented.
  4. Cry a bit.

What did you expect to see?

A version of operator-sdk documented in the CONTRIBUTING.md, to avoid me to do the guesswork of the necessary tools required to contribute. This means a complete list of requirements, not only operator-sdk.

What did you see instead?

A non-complete list of dev requirements in CONTRIBUTING.md

Contributor guide

Research direction
Search the repository's issues and existing CONTRIBUTING.md for the required Operator SDK version and other dependencies. Inspect the codebase's go.mod for Go version and any other tooling requirements. Update CONTRIBUTING.md to include a complete list with versions.
Tech stack
go
Domain
backenddevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85