diff options
author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2023-03-20 15:57:39 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-03-20 15:57:39 (GMT) |
commit | 3ce739cb63344b808f75a200e5e3cbf076504632 (patch) | |
tree | 1ffa2c7bd2969dcd6fb62401bb4fb3d8a17015ed /release_docs/NEWSLETTER.txt | |
parent | be54deeacce621ab974a98c8277496c54393c35c (diff) | |
download | hdf5-3ce739cb63344b808f75a200e5e3cbf076504632.zip hdf5-3ce739cb63344b808f75a200e5e3cbf076504632.tar.gz hdf5-3ce739cb63344b808f75a200e5e3cbf076504632.tar.bz2 |
Bring release_docs scheme from develop (#2612)
Diffstat (limited to 'release_docs/NEWSLETTER.txt')
-rw-r--r-- | release_docs/NEWSLETTER.txt | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/release_docs/NEWSLETTER.txt b/release_docs/NEWSLETTER.txt new file mode 100644 index 0000000..f03f710 --- /dev/null +++ b/release_docs/NEWSLETTER.txt @@ -0,0 +1,25 @@ +INTRODUCTION +============ + +This purpose of this document is to contain entries that can be used to quickly +produce a release newsletter. When something is added to the library that is +"newsletter worthy" (i.e., new feature, CVE fix, etc.) a summary note should +be added here. + +The format should look like this: + +* SUMMARY OF NEWSLETTER-WORTHY THING + + Here is where you describe the summary. Summarize the feature, fix, or + change in general language. Remember, RELEASE.txt is for communicating + technical specifics. Text entered here is more like advertising. + + (GitHub #123, #125) + +The GitHub #s could be relevant issues or PRs. They will probably not appear +in the final newsletter, but are so that the person writing the newsletter +has easy access to context if they have questions. + +Every entry in RELEASE.txt does NOT require an entry here. The newsletter is +for communicating major changes that are of interest to anyone. Minor bugfixes, +memory leak fixes, etc. do not require entries. |