Contributing Guide

This contributing guide is based on CNCF template

• New Contributor Guide

  • Ways to Contribute
  • Ask for Help
  • Development Environment Setup
  • Sign Your Commits
  • Pull Request Checklist

Welcome! We are glad that you want to contribute to our project! 💖

As you get started, you are in the best position to give us feedback on areas of our project that we need help with including:

• Problems found during setting up a new developer environment
• Gaps in our Quickstart Guide or documentation
• Bugs in our automation scripts

If anything doesn't make sense, or doesn't work when you run it, please open a bug report and let us know!

Ways to Contribute

We welcome many different types of contributions including:

• New features
• Builds, CI/CD
• Bug fixes
• Documentation
• Testing

Almost everything happens through a GitHub pull request. Please see also discussions.

Ask for Help

The best way to reach us with a question when contributing is to ask on:

• The original github issue
• The discussion

Development Environment Setup

Instructions

Sign Your Commits

Licensing is important to open source projects. It provides some assurances that the software will continue to be available based under the terms that the author(s) desired. We require that contributors sign off on commits submitted to our project's repositories. We use the Developer Certificate of Origin (DCO) as a way to certify that you wrote and have the right to contribute the code you are submitting to the project.

You sign-off by adding the following to your commit messages. Your sign-off must match the git user and email associated with the commit.

This is my commit message

Signed-off-by: Your Name <your.name@example.com>

Git has a -s command line option to do this automatically:

git commit -s -m 'This is my commit message'

If you forgot to do this and have not yet pushed your changes to the remote repository, you can amend your commit with the sign-off by running

git commit --amend -s 

Pull Request Checklist

When you submit your pull request, or you push new commits to it, our automated systems will run some checks on your new code. We require that your pull request passes these checks, but we also have more criteria than just that before we can accept and merge it. We recommend that you check the following things locally before you submit your code:

• It passes tests: run the following command to run all of the tests locally: go test -v ./cmd/...
• Impacted code has new or updated tests
• Documentation created/updated
• All tests succeed when run by the CI build on a pull request before it is merged
• PR name and merge commit message are satisfy Conventional Commits specification in order to keep Release Notes and main branch history clean