vmware-tanzu
/
velero
mirror of https://github.com/vmware-tanzu/velero.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add header info + fix broken tags 

Signed-off-by: Carlisia <carlisia@vmware.com>
pull/2655/head
Carlisia 2020-06-19 09:03:34 -07:00
parent af79f96513
commit a191363ee6
No known key found for this signature in database
GPG Key ID: D7B7ACEC61F78637
4 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
site/docs/master/code-standards.md
View File

@ -14,6 +14,14 @@ Add that to the PR.
If a PR does not warrant a changelog, the CI check for a changelog can be skipped by applying a `changelog-not-required` label on the PR.
## Copyright header
Whenever a source code file is being modified, the copyright notice should be updated to our standard copyright notice. That is, it should read “Copyright [insert current year] the Velero contributors.”
For new files, the entire copyright and license header must be added.
Please note that doc files do not need a copyright header.
## Code
- Log messages are capitalized.
@ -36,7 +44,7 @@ If a PR does not warrant a changelog, the CI check for a changelog can be skippe
For imports, we use the following convention:
<group><version><api | client | informer | ...>
`<group><version><api | client | informer | ...>`
Example:

2
site/docs/v1.2.0/code-standards.md
View File

@ -34,7 +34,7 @@ Add that to the PR.
For imports, we use the following convention:
<group><version><api | client | informer | ...>
`<group><version><api | client | informer | ...>`
Example:

2
site/docs/v1.3.0/code-standards.md
View File

@ -34,7 +34,7 @@ Add that to the PR.
For imports, we use the following convention:
<group><version><api | client | informer | ...>
`<group><version><api | client | informer | ...>`
Example:

10
site/docs/v1.4/code-standards.md
View File

@ -12,6 +12,14 @@ changelog.
Add that to the PR.
## Copyright header
Whenever a source code file is being modified, the copyright notice should be updated to our standard copyright notice. That is, it should read “Copyright [insert current year] the Velero contributors.”
For new files, the entire copyright and license header must be added.
Please note that doc files do not need a copyright header.
## Code
- Log messages are capitalized.
@ -34,7 +42,7 @@ Add that to the PR.
For imports, we use the following convention:
<group><version><api | client | informer | ...>
`<group><version><api | client | informer | ...>`
Example: