You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributor-guide/modules/ROOT/pages/release-notes.adoc
+34-20Lines changed: 34 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,8 @@ For the latter, you will need to update a Boost history file with a succinct ver
20
20
[square]
21
21
* <<Checklist>>
22
22
* <<Consistency and Formatting>>
23
-
* <<Examples>>
23
+
* <<Release Note Macros>>
24
+
* <<Release Note Examples>>
24
25
* <<Update Boost History>>
25
26
* <<Best Practices>>
26
27
* <<See Also>>
@@ -29,57 +30,57 @@ For the latter, you will need to update a Boost history file with a succinct ver
29
30
30
31
When writing release notes for your library remember that the main goal is to effectively communicate the changes to the end-users. It's always a good practice to put yourself in the mind set of your developers, and think about what information they would need and appreciate. Be brief, but not so brief that only a seasoned user of your library will understand the context.
31
32
32
-
=== Header Information
33
+
=== 1. Header Information
33
34
34
35
Make sure the version number, and date of release are mentioned.
35
36
36
-
=== Summary
37
+
=== 2. Summary
37
38
38
39
If this release addresses particular topics, provide a brief overview of the main changes, enhancements, or the theme of this release if there's one.
39
40
40
-
=== Breaking Changes
41
+
=== 3. Breaking Changes
41
42
42
43
Before detailing other updates, immediately inform users of any backward-incompatible changes. This is crucial as these changes can directly impact existing code. The process for breaking changes is covered in detail in xref:version-control.adoc[].
43
44
44
-
=== API Parameters
45
+
=== 4. API Parameters
45
46
46
47
If you have added additional parameters (or changed a return value, or similar API change) to a function that are not breaking changes, then list them separately. If an API change might break an existing application, then ensure to list it under <<_breaking_changes>>.
47
48
48
-
=== New Features
49
+
=== 5. New Features
49
50
50
51
Describe any new features or major enhancements. For complex features, consider adding a brief example or pointing to updated documentation. If the feature is referenced in an *Issue*, then consider adding a link to that issue.
51
52
52
-
=== Bug Fixes
53
+
=== 6. Bug Fixes
53
54
54
55
List the fixed bugs, ideally with a brief description. If you're using a bug tracking system (like GitHub issues), provide links to the bug reports described in the issues. Include the identifier or number of the bug if available.
55
56
56
-
=== Deprecations
57
+
=== 7. Deprecations
57
58
58
59
Mention any functions, classes, or features that are deprecated and might be removed in future releases.
59
60
60
-
=== Performance Improvements
61
+
=== 8. Performance Improvements
61
62
62
63
Detail any optimizations or performance-related changes, ideally with metrics or benchmarks if they are significant.
63
64
64
-
=== Documentation Updates
65
+
=== 9. Documentation Updates
65
66
66
67
Highlight and link to any significant updates in documentation, new examples, or tutorials.
67
68
68
-
=== Acknowledgements
69
+
=== 10. Acknowledgements
69
70
70
71
Credit contributors or those who reported crucial bugs. Recognize any person or organization that played a special role in this release.
71
72
72
-
=== Known Issues
73
+
=== 11. Known Issues
73
74
74
75
Briefly describe any known limitations or issues that are still unresolved in the current release. Include known compatibility issues - including with compilers and tools, and other libraries.
75
76
76
-
=== Upgrade Notes
77
+
=== 12. Upgrade Notes
77
78
78
79
Provide any specific instructions or recommendations for users upgrading from a previous version, especially if there are any manual steps involved.
79
80
80
81
== Consistency and Formatting
81
82
82
-
* Use clear and concise language. Experience has shown that short release notes are read, long files much less so. Do not add into release notes extensive text that should be in your main library documentation.
83
+
Use clear and concise language. Experience has shown that short release notes are read, long files much less so. Do not add into release notes extensive text that should be in your main library documentation.
83
84
84
85
* Be consistent in the formatting. If you're using bullet points for one section, maintain that for others.
85
86
* Use headers and sub-headers to clearly differentiate sections.
@@ -88,14 +89,25 @@ Provide any specific instructions or recommendations for users upgrading from a
88
89
** Your main library documentation, if there is updated text, examples or tutorials
89
90
** Relevant issues, discussions or threads
90
91
91
-
== Examples
92
+
== Release Note Macros
92
93
93
-
The following examples show some different approaches. Note how many rely on links to issues to provide the detailed information.
94
+
Various macros are available to library authors and maintainers to help keep release notes consistent between libraries, and easier to both write and read. Absolute links _can_ be added to release notes, if necessary, though use of the following macros is encouraged and recommended.
| `boost_phrase:library[ <library name> , <library path>]` | Shows the library title in a consistent format, and links to the library on Git. | `boost_phrase:library[Asio,/libs/asio/]`, `boost_phrase:library[Beast,/libs/beast/]`, `boost_phrase:library[OpenMethod,/libs/openmethod]`
100
+
| `boost_at:<path to file>[ <title>]` | The specified "title" becomes a link to the file. | `Consult the boost_at:/doc/libs/1_90_0/doc/html/boost_asio/history.html[Revision History] for further details.`, `boost_at:/doc/libs/1_90_0/[Documentation]`
101
+
| `boost_gh:pr[ <library name>, <PR number]` | Provides a link to a GitHub PR for the specified library. | `Conform to std::pointer_traits requirements (boost_gh:pr[interprocess,32]).`, `boost_gh:pr[core,205]`
102
+
| `boost_gh:issue[<library name>, <ISSUE number>]` | Provides a link to the GitHub Issue for the specified library. | `Fixed named_condition_any fails to notify (boost_gh:issue[interprocess,62]).`
103
+
|===
104
+
105
+
== Release Note Examples
106
+
107
+
Checking out the release notes from fellow library authors and maintainers is good practice:
0 commit comments