Contribution Guide

Welcome to Tetragon :) !

We’re happy you’re interested in contributing to the Tetragon project.

All contributions are welcome

While this document focuses on the technical details of how to submit patches to the Tetragon project, we value all kinds of contributions.

For example, actions that can greatly improve Tetragon and contribute to its success could be:

• Write a blog post about Tetragon or one of its use cases, we will be happy to add a reference to it in resources.
• Talk about Tetragon during conferences or meetups, similarly, as a blog post, video recordings can be added to resources.
• Share your usage of Tetragon on social platforms, and add yourself to the user list of the Cilium project as a Tetragon user.
• Raise an issue on the repository about a bug, enhancement, or something else. See open a new issue.
• Review a patch on the repository, this might look intimidading but some simple pull requests would benefit from a fresh pair of eyes. See open pull requests.
• Submit a patch to the Tetragon project, for code and documentation contribution. See the next section for a how-to guide.

Guide for code and docs contribution

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.

1. Make sure you have a GitHub account.

2. Fork the Tetragon repository to your GitHub user or organization. The repository is available under github.com/cilium/tetragon.

3. (Optional) Turn off GitHub actions for your fork. This is recommended to avoid unnecessary CI notification failures on the fork.

4. Clone your fork and set up the base repository as upstream remote:

   git clone https://github.com/${YOUR_GITHUB_USERNAME_OR_ORG}/tetragon.git
   cd tetragon
   git remote add upstream https://github.com/cilium/tetragon.git
   

5. Prepare your development setup.

6. Check out GitHub good first issues to find something to work on. If this is your first Tetragon issue, try to start with something small that you think you can do without too much external help. Also avoid assigning too many issues to yourself (see Don’t Lick the Cookie!).

7. Follow the steps in making changes to start contributing.

8. Learn how to run the tests or how to preview and contribute to the docs.

9. Learn how to submit a pull request to the project.

10. Please accept our gratitude for taking the time to improve Tetragon! :)