Skip to content

Instantly share code, notes, and snippets.

@tbg
Created August 31, 2022 13:36
Show Gist options
  • Save tbg/5e77e1baea1ce5e26817587b3a45c991 to your computer and use it in GitHub Desktop.
Save tbg/5e77e1baea1ce5e26817587b3a45c991 to your computer and use it in GitHub Desktop.
<pkg>: <short description - lowercase, no final period>
<what was there before: Previously, ...>
<why it needed to change: This was inadequate because ...>
<what you did about it: To address this, this patch ...>
# Note: to disable this commit template, run: git config --global --add cockroachdb.disable-commit-template true
Release justification:
#Release note: None
# ^-- no user-visible change
#Release note(cli change):
#Release note(ops change):
#Release note(sql change):
#Release note(ui change):
#Release note(security update):
#Release note(general change):
# ^-- e.g., change of required Go version
#Release note(build change):
# ^-- e.g., compatibility with older CPUs
#Release note(enterprise change):
# ^-- e.g., change to backup/restore
#Release note(backwards-incompatible change):
#Release note(performance improvement):
#Release note(bug fix):
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# Commit message recommendation:
#
# ---
# <pkg>: <short description>
#
# Release justification: <release justification>
#
# <what was there before: Previously, ...>
# <why it needed to change: This was inadequate because ...>
# <what you did about it: To address this, this patch ...>
#
# Release note (<category>): <what> <show> <why>
# ---
#
# Wrap long lines! 72 columns is best.
# See also: https://wiki.crdb.io/wiki/spaces/CRDB/pages/73072807/Git+Commit+Messages
#
#
# Categories for release justification:
# - non-production code changes
# - bug fixes and low-risk updates to new functionality
# - fixes for high-priority or high-severity bugs in existing functionality
# - low risk, high benefit changes to existing functionality
#
# The release note must be present if your commit has user-facing
# or backward-incompatible changes. Use 'Release note: None' otherwise.
#
# Things to keep in mind for release notes:
# - past tense (this was changed...) or present tense (now possible to...)
# - what has changed: narrow down the product area / feature
# Note: for bug fixes, indicate since when the bug was present
# - show what changed: how a user can see the change for themselves
# Note: for bug fixes, show the symptom(s) to recognize the bug
# - why the change: who does this impact, how and why should they care
#
# See also: https://wiki.crdb.io/wiki/spaces/CRDB/pages/186548364/Release+notes
#
# Example release notes:
#
# Release note (sql change): The IMPLEMENT statement was extended
# to support the new STEP clause. This can be used to
# implement more gradually, as often required by teams of two
# or more.
#
# Release note (bug fix): The system.replication_stats report no longer
# erroneously considers some ranges belonging to table partitions to be
# over-replicated. This bug was present since version 19.2.
#
# Categories for release notes: see template above.
#
# On branch roachtest-stats-checks
# Your branch is ahead of 'tbg/roachtest-stats-checks' by 2 commits.
# (use "git push" to publish your local commits)
#
# Untracked files:
# logs.bz2.gz
# logs/
#
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment