Documentation for version v1.5 is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.
Start contributing
Before you start
- Please familiarize yourself with the Code of Conduct before contributing.
- Also, see CONTRIBUTING.md for instructions on the developer certificate of origin that we require.
Creating a design doc
Having a high level design document with the proposed change and the impacts helps the maintainers evaluate if a major change should be incorporated.
To make a design pull request, you can copy the template found in the design/_template.md file into a new Markdown file.
Finding your way around
You may join the Velero community and contribute in many different ways, including helping us design or test new features. For any significant feature we consider adding, we start with a design document. You may find a list of in progress new designs here: https://github.com/vmware-tanzu/velero/pulls?q=is%3Aopen+is%3Apr+label%3ADesign. Feel free to review and help us with your input.
You can also vote on issues using :+1: and :-1:, as explained in our Feature enhancement request and Bug issue templates. This will help us quantify importance and prioritize issues.
For information on how to connect with our maintainers and community, join our online meetings, or find good first issues, start on our Velero community page.
Please browse our list of resources, including a playlist of past online community meetings, blog posts, and other resources to help you get familiar with our project: Velero resources.
Contributing
If you are ready to jump in and test, add code, or help with documentation, please use the navigation on the left under Contribute.
Getting Started
To help you get started, see the documentation.