Skip to content

Commit 4f41334

Browse files
committed
Add known issues section
Reviewed-by: Richard Levitte <[email protected]> Reviewed-by: Matt Caswell <[email protected]> (Merged from openssl#22774)
1 parent 036de8d commit 4f41334

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

dev/NEWS-FORMAT.md

+16
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,22 @@ possible and practical.
133133

134134
List features in descending order of significance (approximately).
135135

136+
#### Listing known issues
137+
138+
Known issues can be called out as follows:
139+
140+
```text
141+
The following known issues are present in this release and will be rectified in
142+
a future release:
143+
144+
* xxx (#12345)
145+
146+
```
147+
148+
The editorial conventions for this block are similar to those for feature
149+
additions, except that an issue number is listed rather than a reference to a
150+
standard.
151+
136152
#### Listing documentation enhancements
137153

138154
Significant documentation enhancements can be called out as follows:

0 commit comments

Comments
 (0)