From b1b4934569f12afb5289a0a414a98dc7365c48bd Mon Sep 17 00:00:00 2001 From: Tiexin Guo Date: Wed, 3 Apr 2024 08:43:27 +0800 Subject: [PATCH] docs: update publishing a release in hacking (#1173) Update `HACKING.md` "Publishing a Release" part. --- HACKING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/HACKING.md b/HACKING.md index 9bc7e9829..0643c0c62 100644 --- a/HACKING.md +++ b/HACKING.md @@ -268,9 +268,9 @@ To make a release of the ops library, do the following: E.g. 2.3.12 Bug fixes for the Juju foobar feature when using Python 3.12 4. Use the "Generate Release Notes" button to get a copy of the changes into the notes field. -5. Group the changes by the commit type (feat, fix, etc), stripping that prefix - from the bullet point, and using the full name ("Features", not "feat") for - the group heading. +5. Group the changes by the commit type (feat, fix, etc.) and use full names (e.g., "Features", + not "feat") for group headings. Strip the commit type prefix from the bullet point. Strip the + username (who did each commit) if the author is a member of the Charm Tech team. 6. Where appropriate, collapse multiple tightly related bullet points into a single point that refers to multiple commits. 7. Create a new branch, and copy this text to the [CHANGES.md](CHANGES.md) file,