/docs/contribution-guide/ Recent content in Contribution Guide on Tetragon - eBPF-based Security Observability and Runtime Enforcement Hugo en /docs/contribution-guide/development-setup/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/contribution-guide/development-setup/ Building and running Tetragon For local development, you will likely want to build and run bare-metal Tetragon. Requirements A Go toolchain with the version specified in the main go.mod; GNU make; A running Docker service (you can use Podman as well); The docker-buildx-plugin (you may already have this); For building tests, libcap and libelf (in Debian systems, e.g., install libelf-dev and libcap-dev). Build everything You can build most Tetragon targets as follows (this can take time as it builds all the targets needed for testing, see minimal build): /docs/contribution-guide/making-changes/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/contribution-guide/making-changes/ Make sure the main branch of your fork is up-to-date: git fetch upstream git checkout main git merge upstream/main For further reference read GitHub syncing a fork documentation. Create a PR branch with a descriptive name, branching from main: git switch -c pr/${GITHUB_USERNAME_OR_ORG}/changes-to-something main Make the changes you want. Test your changes. Follow Development setup and Running tests guides to build and test Tetragon. Make sure that all new code is covered by unit and/or end-to-end tests where feasible. /docs/contribution-guide/running-tests/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/contribution-guide/running-tests/ Tetragon has several types of tests: Go tests, composed of unit tests for userspace Go code and Go and BPF code. BPF unit tests, testing specifing BPF functions. E2E tests, for end-to-end tests, installing Tetragon in Kubernetes clusters and checking for specific features. Those tests are running in the Tetragon CI on various kernels1 and various architectures (amd64 and arm64). Go tests To run the Go tests locally, you can use: /docs/contribution-guide/documentation/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/contribution-guide/documentation/ Thank you for taking the time to improve Tetragon’s documentation. Find the content All the Tetragon documentation content can be found under github.com/cilium/tetragon/docs/content/en/docs. Note The main page served from a directory path is named _index.md. For example /docs/contribution-guide is available under /docs/content/en/docs/contribution-guide/_index.md. Style to follow We generally follow the Kubernetes docs style guide k8s.io/docs/contribute/style/style-guide. Preview locally To preview the documentation locally, use one of the method below. Then browse to localhost:1313/docs, the default port used by Hugo to listen. /docs/contribution-guide/submitting-a-pull-request/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/contribution-guide/submitting-a-pull-request/ Note This guide is partially based on the Cilium contributing guide. Caution This guide assumes that you have already made and tested changes you want to contribute. If you have not, please follow the steps from the Contribution Guide. Commit changes Save your changes in one or more commits. If you are not comfortable with Git yet (in particular with git rebase), refer to the GitHub documentation. Caution Commits should separate logical chunks of code and not represent a chronological list of changes. /docs/contribution-guide/developer-certificate-of-origin/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/contribution-guide/developer-certificate-of-origin/ To improve tracking of who did what, we’ve introduced a “sign-off” procedure, make sure to read and apply the Developer’s Certificate of Origin. /docs/contribution-guide/release-notes/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/contribution-guide/release-notes/ Tetragon release notes are published on the GitHub releases page. To ensure the release notes are accurate and helpful, contributors should write them alongside development. Then, at the time of release, the final notes are compiled and published. This guide is intended for both Tetragon developers and reviewers. Please follow it when creating or reviewing pull requests. release-note blurb in PR When you create a pull request, the template will include a release-note blurb in the description. /docs/contribution-guide/contributor-ladder/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/contribution-guide/contributor-ladder/ Tetragon is a sub-project of the Cilium project and follows the same governance model, community processes, and contributor growth paths as Cilium. To support contributors in gaining both privileges and responsibilities, we adopt the shared Contributor Ladder. This contributor ladder defines how contributors can grow from community participants to project maintainers, along with the expectations at each level. Community members generally start at the first levels of the ladder and advance as their involvement deepens.