search

OT-CONTAINER-KIT / redis-operator

A golang based redis operator that will make/oversee Redis standalone/cluster/replication/sentinel mode setup on top of the Kubernetes.
https://ot-redis-operator.netlify.app/
Apache License 2.0
734 stars 207 forks source link

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

Open evrardjp opened 2 months ago

evrardjp commented 2 months ago

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

evrardjp commented 2 months ago

The cry part is a joke, in case you're wondering.