Skip to content

Commit 1003475

Browse files
authored
Call out big refactorings as something that release notes should cover (GoogleCloudPlatform#12918)
1 parent 2cabee5 commit 1003475

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/content/code-review/release-notes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,10 @@ For each release note block, choose an appropriate type from the following list:
9898
Do | Don't
9999
-- | -----
100100
Use past tense to describe the end state after the change is released. Start with a verb. For example, "added...", "fixed...", or "resolved...". You can use future tense to describe future changes, such as saying that a deprecated field will be removed in a future version. | Don't use present or future tense to describe changes that are included in the pull request.
101-
Write user-focused release notes. For example, reference specific impacted terraform resource and field names, and discuss changes in behavior users will experience. | Avoid API field/resource/feature names. Avoid implementation details. Avoid language that requires understanding of provider internals.
101+
Write user-focused release notes. For example, reference specific impacted terraform resource and field names, and discuss changes in behavior users will experience. | Avoid API field/resource/feature names. Avoid implementation details. Avoid language that requires understanding of provider internals. However, in case of substantial refactorings like API version changes or engine changes (tpgtools/DCL -> MMv1, handwritten <> MMv1) **do** cover the change so users can quickly identify the release if they are affected by the change.
102102
Surround resource or field names with backticks. | Don't use resource or field names without punctuation or with other punctuation like quotation marks.
103103
Use impersonal third person. | Don't use "I", "you", etc.
104-
If the pull request impacts any specific, begin your release note with that product name followed by a colon. Use lower case for the first letter after the colon. For example, `cloudrun: added...` For MMv1 resources, use the folder name that contains the yaml files as the product name; for handwritten or tpgtools resources, use the API subdomain; for broad cross-product changes, use `provider`. | Don't begin your release note with the full resource name. Don't add backticks around the product name. Don't capitalize the first letter after the colon.
104+
If the pull request impacts a specific product, begin your release note with that product name followed by a colon. Use lower case for the first letter after the colon. For example, `cloudrun: added...` For MMv1 resources, use the folder name that contains the yaml files as the product name; for handwritten or tpgtools resources, use the API subdomain; for broad cross-product changes, use `provider`. | Don't begin your release note with the full resource name. Don't add backticks around the product name. Don't capitalize the first letter after the colon.
105105

106106
### Examples
107107

0 commit comments

Comments
 (0)