Skip to content

As a contributor I want to know the steps to create a successful PR #141

@lfrancke

Description

@lfrancke

Currently one needs to know to run make regenerate-charts to guarantee an up-to-date PR that won't fail in Github Actions. And there's probably other things.... like pointing out that there are integration tests in another repository and how to run them.

The whole contributions workflow needs to be documented.

I opened the ticket here but it could just as well be moved to the operator-templating repository if all you want to do is change the README.

I think this makes sense but it's just a suggestion:

  1. Change READMEs of the operators to point to the contributor guide (in the templating repo)
  2. Add a section to the contributor guide on how to create a PR, how to run make etc.

If you think another way of documenting this (e.g. in the README only or in addition) then please feel free as long as we have this documentation I'm fine.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions