Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain bundle conventions in the contributing guide #13

Open
carolynvs opened this issue Jun 1, 2022 · 0 comments
Open

Explain bundle conventions in the contributing guide #13

carolynvs opened this issue Jun 1, 2022 · 0 comments
Labels
meta Things necessary to make this project run day to day

Comments

@carolynvs
Copy link
Member

We have some unwritten expectations/requirements for example bundles that should be explained in our CONTRIBUTING.md file:

  1. name, version and registry are required. Do not use reference.
  2. The bundle README.md should provide enough information that someone can copy/paste their way to victory and installing the example bundle. So include any configuration/setup such as required credentials, parameters, or infrastructure (like a cluster). It's okay to link to a doc that explains how to do that stuff, you don't need to repeat it. Also include a "Try it out" section that gives them the install command with all required parameters/flags included.
  3. If the bundle provisions any resources, include a "Cleanup" section that walks them through uninstalling the bundle cleanly so that they aren't billed for any lingering resources.
@carolynvs carolynvs added the meta Things necessary to make this project run day to day label Jun 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Things necessary to make this project run day to day
Projects
None yet
Development

No branches or pull requests

1 participant