mirror of
https://github.com/vmware-tanzu/velero.git
synced 2026-01-09 06:33:22 +00:00
de8962ea18
* Use a helper function when querying w/ backup label Setting or querying for a backup label name should always pass the value through the GetValidName function. This change passes query uses of the backup label value through the GetValidName function by introducing 2 new helpers, one for making a Selector, one for making a ListOptions. It also removes functions returning the same data, but under unecessarily specific names. Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Document using the label.GetValidName function Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Update copyright year Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Clarify labels.GetValidName and annotations Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Move functions to pkg/label Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Fix function comments Signed-off-by: Nolan Brubaker <brubakern@vmware.com>
134 lines
4.1 KiB
Markdown
134 lines
4.1 KiB
Markdown
# Code Standards
|
|
|
|
## Adding a changelog
|
|
|
|
Authors are expected to include a changelog file with their pull requests. The changelog file
|
|
should be a new file created in the `changelogs/unreleased` folder. The file should follow the
|
|
naming convention of `pr-username` and the contents of the file should be your text for the
|
|
changelog.
|
|
|
|
velero/changelogs/unreleased <- folder
|
|
000-username <- file
|
|
|
|
Add that to the PR.
|
|
|
|
## Code
|
|
|
|
- Log messages are capitalized.
|
|
|
|
- Error messages are kept lower-cased.
|
|
|
|
- Wrap/add a stack only to errors that are being directly returned from non-velero code, such as an API call to the Kubernetes server.
|
|
|
|
```bash
|
|
errors.WithStack(err)
|
|
```
|
|
|
|
- Prefer to use the utilities in the Kubernetes package [`sets`](https://godoc.org/github.com/kubernetes/apimachinery/pkg/util/sets).
|
|
|
|
```bash
|
|
k8s.io/apimachinery/pkg/util/sets
|
|
```
|
|
|
|
## Imports
|
|
|
|
For imports, we use the following convention:
|
|
|
|
<group><version><api | client | informer | ...>
|
|
|
|
Example:
|
|
|
|
import (
|
|
corev1api "k8s.io/api/core/v1"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
corev1client "k8s.io/client-go/kubernetes/typed/core/v1"
|
|
corev1listers "k8s.io/client-go/listers/core/v1"
|
|
|
|
velerov1api ""github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
|
|
velerov1client "github.com/vmware-tanzu/velero/pkg/generated/clientset/versioned/typed/velero/v1"
|
|
)
|
|
|
|
## Mocks
|
|
|
|
We use a package to generate mocks for our interfaces.
|
|
|
|
Example: if you want to change this mock: https://github.com/vmware-tanzu/velero/blob/master/pkg/restic/mocks/restorer.go
|
|
|
|
Run:
|
|
|
|
```bash
|
|
go get github.com/vektra/mockery/.../
|
|
cd pkg/restic
|
|
mockery -name=Restorer
|
|
```
|
|
|
|
Might need to run `make update` to update the imports.
|
|
|
|
## Kubernetes Labels
|
|
|
|
When generating label values, be sure to pass them through the `label.GetValidName()` helper function.
|
|
|
|
This will help ensure that the values are the proper length and format to be stored and queried.
|
|
|
|
In general, UIDs are safe to persist as label values.
|
|
|
|
This function is not relevant to annotation values, which do not have restrictions.
|
|
|
|
## DCO Sign off
|
|
|
|
All authors to the project retain copyright to their work. However, to ensure
|
|
that they are only submitting work that they have rights to, we are requiring
|
|
everyone to acknowledge this by signing their work.
|
|
|
|
Any copyright notices in this repo should specify the authors as "the Velero contributors".
|
|
|
|
To sign your work, just add a line like this at the end of your commit message:
|
|
|
|
```
|
|
Signed-off-by: Joe Beda <joe@heptio.com>
|
|
```
|
|
|
|
This can easily be done with the `--signoff` option to `git commit`.
|
|
|
|
By doing this you state that you can certify the following (from https://developercertificate.org/):
|
|
|
|
```
|
|
Developer Certificate of Origin
|
|
Version 1.1
|
|
|
|
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
|
1 Letterman Drive
|
|
Suite D4700
|
|
San Francisco, CA, 94129
|
|
|
|
Everyone is permitted to copy and distribute verbatim copies of this
|
|
license document, but changing it is not allowed.
|
|
|
|
|
|
Developer's Certificate of Origin 1.1
|
|
|
|
By making a contribution to this project, I certify that:
|
|
|
|
(a) The contribution was created in whole or in part by me and I
|
|
have the right to submit it under the open source license
|
|
indicated in the file; or
|
|
|
|
(b) The contribution is based upon previous work that, to the best
|
|
of my knowledge, is covered under an appropriate open source
|
|
license and I have the right under that license to submit that
|
|
work with modifications, whether created in whole or in part
|
|
by me, under the same open source license (unless I am
|
|
permitted to submit under a different license), as indicated
|
|
in the file; or
|
|
|
|
(c) The contribution was provided directly to me by some other
|
|
person who certified (a), (b) or (c) and I have not modified
|
|
it.
|
|
|
|
(d) I understand and agree that this project and the contribution
|
|
are public and that a record of the contribution (including all
|
|
personal information I submit with it, including my sign-off) is
|
|
maintained indefinitely and may be redistributed consistent with
|
|
this project or the open source license(s) involved.
|
|
```
|