From d8ab6286a87c7be14649f6f533217799658c8d45 Mon Sep 17 00:00:00 2001 From: Ingrid Crant Date: Fri, 9 Feb 2024 15:01:59 -0500 Subject: [PATCH] contributing.md --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ deploy/kustomization.yaml | 1 + 2 files changed, 34 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3335b46 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing + +Thank you for your interest in contributing to the 1Password kubernetes-secrets-injector project 👋! Before you start, please take a moment to read through this guide to understand our contribution process. + +## Getting Started + +## Testing + +## 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](https://developer.1password.com/docs/ssh/git-commit-signing/). + +### 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](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) +2. [Add the SSH key to your GitHub account](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) +3. [Configure git to use your SSH key for commits signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key#telling-git-about-your-ssh-key) + +### Sign commits with gpg + +Follow the steps below to set up commit signing with `gpg`: + +1. [Generate a GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key) +2. [Add the GPG key to your GitHub account](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account) +3. [Configure git to use your GPG key for commits signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key#telling-git-about-your-gpg-key) diff --git a/deploy/kustomization.yaml b/deploy/kustomization.yaml index 0db5fac..5e49bd1 100644 --- a/deploy/kustomization.yaml +++ b/deploy/kustomization.yaml @@ -4,3 +4,4 @@ resources: - permissions.yaml - deployment.yaml - service.yaml +namespace: default