docs: add more release note guidance to commit msg docs#165432
docs: add more release note guidance to commit msg docs#165432trunk-io[bot] merged 1 commit intocockroachdb:masterfrom
Conversation
|
😎 Merged successfully - details. |
|
This change is |
jhlodin
left a comment
jhlodin
left a comment
There was a problem hiding this comment.
Proposing edits based on feedback we've gotten about the usefulness of our release notes to customers trying to perform upgrades.
rafiss
changed the title
rafiss
left a comment
rafiss
left a comment
There was a problem hiding this comment.
Thanks for re-adding this!
| Use one category per release note. When a change could fit multiple | ||
| categories, choose the one that makes the most sense from a user perspective. | ||
| Use the category names below verbatim -- the extraction script catches common | ||
| misspellings, but unrecognized categories end up in "Miscellaneous" for the |
There was a problem hiding this comment.
The Confluence page lists accepted alternate spellings for each category (e.g., backwards-incompatible change, bugfix, operational change, performance, multi-tenancy, etc.). This PR doesn't list the accepted alternates, which could be useful for authors.
There was a problem hiding this comment.
I imagine we'd prefer, all else being equal, tp have the canonical form be what we actively promote via our guidance for authors, as consistency makes it easier to read/scan these. Even if the script technically accepts some alternative spellings and remaps them as needed, do we benefit from promoting the usage of those in the guide?
There was a problem hiding this comment.
I'll go ahead and land the canonical spellings for now and we can decide if we want to encourage use of alternatives in a follow-up as needed.
Release note: none. Epic: none.
|
TFTRs! /trunk merge |
5 participants
Release note: none.
Epic: none.