Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 2.98 KB
Raw

Contributing to Teleport Helm charts

Firstly, thanks for considering a contribution to Teleport's Helm charts.

A couple of brief warnings

Please note that we won't accept contributions that are particularly esoteric, difficult to use or poorly implemented. Our goal is to:

  • keep the charts easy to use
  • keep all functionality relevant to a broad audience
  • always use sane defaults which are right for most deployments
  • require as few values changes as possible for everyday usage

If your functionality is only really useful to you, it's best to keep it on your own fork and deploy from there.

Sometimes Teleport staff may take over your PR and make changes, implement it in a slightly different way, or just merge it as part of a bigger merge of multiple PRs at once. We will make sure that you still get credit in the final commit if this happens.

Guidelines

Here is a list of things that you should do to make sure to do in order to get a smooth PR review process with minimal changes required:

  1. Add a linter file which includes examples for any new values you add under the .lint/ directory for the appropriate chart. The linter will check this during CI and make sure the values are correctly formatted, along with your chart changes. The file should contain all necessary values to deploy a reference install.

  2. Add unit tests for your functionality under the tests/ directory for the appropriate chart, particularly if you're adding new values. Make sure that all functionality is tested, so we can be sure that it works as intended for every use case. A good tip is to use your newly added linter file to set values appropriate for your test.

  3. Add any new values at the correct location in the values.schema.json file for the appropriate chart. This will ensure that Helm is able to validate values at install-time and can prevent users from making easy mistakes.

  4. Document any new values or changes to existing behaviour in the chart reference.

  5. Run make lint-helm test-helm from the root of the repo before raising your PR. You will need yamllint, helm and helm-unittest installed locally.

make -C build.assets lint-helm test-helm will run these via Docker if you'd prefer not to install locally.

Note: there are multiple forks for the helm-unittest plugin. They are not compatible and don't provide the same featureset (e.g. including templates from sub-directories). Our tests rely on features and bugfixes that are only available on the quintush fork (which seems to be the most maintained at the time of writing)

  1. If you get a snapshot error during your testing, you should verify that your changes intended to alter the output, then run make test-helm-update-snapshots to update the snapshots and commit these changes along with your PR.

Again, make -C build.assets test-helm-update-snapshots will run this via Docker.

  1. Document the changes you've made in the PR summary.

Thanks!