mirrors/velero
1
0
Fork 0
mirror of https://github.com/vmware-tanzu/velero.git synced 2026-08-15 11:46:06 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #6844 from sseago/pr-standards

Browse Source
This commit is contained in:
Shubham Pampattiwar
2023-10-09 14:33:06 -07:00
committed by GitHub
parent 1c1054dedc cd7e2d6fcc
commit 541425ba97
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
site/content/docs/main/code-standards.md
+18
View File
@@ -8,6 +8,24 @@ toc: "true"
When opening a pull request, please fill out the checklist supplied the template. This will help others properly categorize and review your pull request.
### PR title
Make sure that the pull request title summarizes the change made (and not just "fixes issue #xxxx"):
Example PR titles:
- "Check for nil when validating foo"
- "Issue #1234: Check for nil when validating foo"
### Cherry-pick PRs
When a PR to main needs to be cherry-picked to a release branch, please wait until the main PR is merged first before creating the CP PR. If the CP PR is made before the main PR is merged, there is a risk that PR modifications in response to review comments will not make it into the CP PR.
The Cherry-pick PR title should reference the branch it's cherry-picked to and the fact that it's a CP of a commit to main:
- "[release-1.13 CP] Issue #1234: Check for nil when validating foo"
## Adding a changelog
Authors are expected to include a changelog file with their pull requests. The changelog file