Skip to content

Commit

Permalink
Add known issues section
Browse files Browse the repository at this point in the history
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from #22774)

(cherry picked from commit 4f41334)
  • Loading branch information
hlandau committed Nov 29, 2023
1 parent f90beba commit 0d6a98b
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions dev/NEWS-FORMAT.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,22 @@ possible and practical.

List features in descending order of significance (approximately).

#### Listing known issues

Known issues can be called out as follows:

```text
The following known issues are present in this release and will be rectified in
a future release:
* xxx (#12345)
```

The editorial conventions for this block are similar to those for feature
additions, except that an issue number is listed rather than a reference to a
standard.

#### Listing documentation enhancements

Significant documentation enhancements can be called out as follows:
Expand Down

0 comments on commit 0d6a98b

Please sign in to comment.