File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -98,3 +98,15 @@ the last line for the previous release note example:
9898Note that if a change requires a release note, it should generally
9999have a corresponding pull request. Exceptions are fixes for
100100vulnerabilities, 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.
You can’t perform that action at this time.
0 commit comments