Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

59 lines (34 loc) · 2.87 KB
Raw

Contributing

Thank you for your interest in contributing to the 1Password connect-helm-chart project 👋! We sincerely appreciate the time and effort you put into improving our Helm Charts. Before you start, please take a moment to read through this guide to understand our contribution process.

Getting Started

To start contributing, get the latest Helm release.

Testing

NOTE: This only applies to changes made in ./charts/connect.

Run the following command to test changes made to the Connect Helm chart:

helm test connect

Debugging

  • Running helm lint in the applicable subdirectory will verify that your chart follows best practices.

  • To run helm template --debug:

    1. navigate to the root of the repository
    2. cd..
    3. helm template connect-helm-charts/charts/secrets-injector --debug for secrets-injector OR helm template connect-helm-charts/charts/connect --debug for connect.

For more debugging templates, feel free to consult the docs.

Documentation Updates

If adding a new configuration, update documentation for the tables in the Connect README or in the Secrets Injector README

Sign your commits

To get your PR merged, we require you to sign your commits.

Sign commits with 1Password

You can also sign commits using 1Password, which lets you sign commits with biometrics without the signing key leaving the local 1Password process.

Learn how to use 1Password to sign your commits.

Sign commits with ssh-agent

Follow the steps below to set up commit signing with ssh-agent:

  1. Generate an SSH key and add it to ssh-agent
  2. Add the SSH key to your GitHub account
  3. Configure git to use your SSH key for commits signing

Sign commits with gpg

Follow the steps below to set up commit signing with gpg:

  1. Generate a GPG key
  2. Add the GPG key to your GitHub account
  3. Configure git to use your GPG key for commits signing