Thank you for contributing your time and expertise to Tekton. This document describes the contribution guidelines for the project.
Note: Before you start contributing, you must read and abide by our Code of Conduct.
To set up your environment and begin working on our code, see Developing for Tekton.
The community repo contains information on the following:
- Development standards, including:
- Contacting other contributors
- Tekton development processes, including:
- Making changes to the Tekton API
- Understanding the Tekton automation infrastructure
Additionally, please read the following resources specific to Tekton Pipelines:
For support in contributing to specific areas, contact the relevant Tekton Pipelines Topical Owner(s).
The project includes GitHub slash commands to automate common workflows:
Automatically cherry-picks a merged PR to one or more target branches.
Usage: /cherry-pick <target-branch> [<target-branch2> ...]
Examples:
/cherry-pick release-v0.47.x/cherry-pick release-v0.47.x release-v1.3.x
Requirements:
- PR must be merged
- User must have write permissions
- Target branch(es) must exist
The command creates a new PR with the cherry-picked changes for each target branch.
Rebases a PR branch against its base branch and force pushes the result.
Usage: /rebase
Requirements:
- PR must be open
- PR must not be from a fork (branch must be in tektoncd/pipeline)
- User must have write permissions
The command rebases the PR's head branch onto the base branch. If there are
conflicts, it reports them in a comment. Uses --force-with-lease for safe
force pushing.
If you want to contribute to Tekton documentation, see the Tekton Documentation Contributor's Guide.
This guide describes:
- The contribution process for documentation
- Our standards for writing high quality content
- Our formatting conventions
It also includes a primer for getting started with writing documentation and improving your writing skills.