From cd7e2d6fcc515c11098d85ef933b2089fb6e0770 Mon Sep 17 00:00:00 2001 From: Scott Seago Date: Tue, 19 Sep 2023 09:43:31 -0400 Subject: [PATCH] Expanded PR section of code standards doc Signed-off-by: Scott Seago --- site/content/docs/main/code-standards.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/site/content/docs/main/code-standards.md b/site/content/docs/main/code-standards.md index c12317981a..d2f19bc67a 100644 --- a/site/content/docs/main/code-standards.md +++ b/site/content/docs/main/code-standards.md @@ -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