Contribution Guide
We’re happy you’re interested in contributing to the Tetragon project.
This section of the Tetragon documentation will help you make sure you have an environment capable of testing changes to the Tetragon source code, and that you understand the workflow of getting these changes reviewed and merged upstream.
Clone and provision an environment
Make sure you have a GitHub account.
Fork the Tetragon repository to your GitHub user or organization.
Turn off GitHub actions for your fork as described in the GitHub Docs.
This is recommended to avoid unnecessary CI notification failures on the fork.
Clone your
${YOUR_GITHUB_USERNAME_OR_ORG}/tetragon
fork into yourGOPATH
, and set up the base repository asupstream
remote:mkdir -p "${GOPATH}/src/github.com/cilium" cd "${GOPATH}/src/github.com/cilium" git clone https://github.com/${YOUR_GITHUB_USERNAME_OR_ORG}/tetragon.git cd tetragon git remote add upstream https://github.com/cilium/tetragon.git
Prepare your Development setup, see section below.
Check the GitHub issues for good tasks to get started.
Follow the steps in Making changes to start contributing. Welcome :)!
Development setup
This will help you getting started with your development setup to build Tetragon
Making changes
Learn how to make your first changes to the project
Running tests
Learn how to run the tests of the project
Submitting a pull request
Learn how to submit a pull request to the project
Developer's certificate of origin
Learn about the “sign-off” procedure