✨ (go/v3): Add README.md template to scaffolding templates

[everettraven]

Description of changes

This adds a new file to the go/v3 scaffolding templates for scaffolding a README.md file. The new file can be found at pkg/plugins/golang/v3/scaffolds/internal/templates/readme.go

The file pkg/plugins/golang/v3/init.go was modified to add the scaffolding of the README.md file to the go/v3 init process.

Motivation for the change

As per issue #2597 :

This suggestion came from new users. The idea would be to provide by default a README to the projects so that, we could:

• encourage authors to create the README.md
• provide on the README.md the default make file targets and help skill up on how to use it
• additionally, for other projects such as SDK which uses KB as lib and adds on top nice helpers; would be possible for it to supplement the README with default info such as "how to build/update and test the bundle with OLM"

Additional Information

resolves #2597

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: everettraven / name: Bryce Palmer (390e070, 45de7c3)

[k8s-ci-robot]

Welcome @everettraven!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubebuilder has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @everettraven. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[rashmigottipati]

/ok-to-test

[camilamacedo86]

Thank you for the great contribution 🥇
some nits were added in the review.

Also,
a) could we update the title to clarifies that the addition is valid only for go/v3 plugins with :

✨ (go/v3) : Add ...

b) could you please squash the commits? We need have 1 commit per PR?

[everettraven]

Thank you for the great contribution 1st_place_medal some nits were added in the review.

Also, a) could we update the title to clarifies that the addition is valid only for go/v3 plugins with :

sparkles (go/v3) : Add ...

b) could you please squash the commits? We need have 1 commit per PR?

Both of these should now be done. Thanks for the detailed review, it helped me learn a lot more about Operators vs Controllers and how Kubebuilder is working!

[everettraven]

/retest

[camilamacedo86]

That is a great job. 🥇
For me,

/approved

However, I think would be nice if we check with the others what they think as well.
WDYT about also adding this one in the channels?

@ryanbrainard @varshaprasad96 @rashmigottipati @jmrodri wdyt?

[everettraven]

That is a great job. 1st_place_medal For me,

/approved

However, I think would be nice if we check with the others what they think as well. WDYT about also adding this one in the channels?

@ryanbrainard @varshaprasad96 @rashmigottipati @jmrodri wdyt?

I will go ahead and add this to the Kubebuilder channel as a PTAL. Thanks @camilamacedo86 !

[varshaprasad96]

/lgtm
@camilamacedo86 though this isn't a breaking change per say, it needs a new KB release?

[everettraven]

/retest

[rashmigottipati]

/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, everettraven, rashmigottipati, varshaprasad96

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [camilamacedo86]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment