Skip to content

Commit 18fd9c5

Browse files
authored
Merge PR-9619 from sverker/release-note-doc
Add release notes doc section about bug fixes
2 parents 5c1e626 + 5650226 commit 18fd9c5

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

HOWTO/RELEASE-NOTES.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,3 +98,15 @@ the last line for the previous release note example:
9898
Note that if a change requires a release note, it should generally
9999
have a corresponding pull request. Exceptions are fixes for
100100
vulnerabilities, which are often released without a pull request.
101+
102+
### Bug fixes
103+
104+
When the release note describes a fix to a bug, consider include the following:
105+
106+
* **Symptom** -- Describe the undesired effect of the bug. Like for example
107+
an incorrect function return value, an unexpectedly raised exception
108+
or a beam process crash.
109+
* **Trigger** -- The conditions that are needed for the bug to manifest.
110+
Like specific function arguments or actions that need to happen in a specific
111+
order or at the same time.
112+
* **Version** -- The oldest OTP version where the bug exists.

0 commit comments

Comments
 (0)