diff options
author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2023-02-13 14:03:11 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-02-13 14:03:11 (GMT) |
commit | 768575225ecfe81e8965c47369576c9befb9d4c1 (patch) | |
tree | 6bf82693dc0b4f8b8d72f94f6afea1fcc378f444 /CONTRIBUTING.md | |
parent | b5ddec4554731191f3a7f04c57c87dae61762e74 (diff) | |
download | hdf5-768575225ecfe81e8965c47369576c9befb9d4c1.zip hdf5-768575225ecfe81e8965c47369576c9befb9d4c1.tar.gz hdf5-768575225ecfe81e8965c47369576c9befb9d4c1.tar.bz2 |
Update release_docs HISTORY scheme (#2443)
We will no longer maintain HISTORY files for other maintenance branches,
so those have been removed. Adds a README.md explaining the purpose
and procedures of HDF5 HISTORY. Also adds a newsletter template and
updates the RELEASE.txt note part of CONTRIBUTING.md.
Also cleans out RELEASE.txt post-HDF5-1.14.0
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 31 |
1 files changed, 1 insertions, 30 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62b00ea..dc1a200 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,36 +86,7 @@ application developers, library developers, and system administrators. # Release Note <A NAME="releasenote"></A> -* **Entry Syntax** -The release note entry syntax is shown below. - -``` - - Title/Problem - - Problem/Solution - - Signature -``` - -* **Entry Elements** - The elements of the entry - title, problem, solution, and signature - are described in more detail in the table -below. Descriptions of the problem and the solution should be clear without any ambiguities and should be short without losing clarity or specifics. - - * **Title** - The title or tag should identify one or more categories that will help readers decide if the entry is something they need to study. Can be combined with the `Problem` element - * **Problem** - Describe the problem and how users might see the problem in a paragraph. -You might also consider the following as you describe the problem: - * Under what specific conditions does this issue arise? - * Under what specific conditions are we sure this issue will not arise? - * For a performance issue, instead of saying something is a performance issue, describe what the performance impact of issue is? - * **Solution** - Describe the solution in another paragraph. -You might also consider the following as you describe the solution: - * What was done to resolve the issue? - * What is the functional impact? - * Is there a workaround – a way for users design their software so as not to encounter the issue? If so, what is the workaround? - * For a performance fix, how has the performance improved? Links to published documentation would be good. - * **Signature** - Each entry must be signed with the initials of the author, the date in YYYY/MM/DD format, and the JIRA ticket number. The -following is an example entry written by developer Xavier Zolo on April 16, 2014 about JIRA ticket HDFFV-5555: (XYZ - 2014/04/16, HDFFV-5555). The -signature is enclosed in parentheses. JIRA or Github numbers should not be used in the description of the problem or the solution. They are like -abbreviations that customers and external users will not be able to interpret. +The use and format of release notes is described in `doc/release_txt_notes.md` in this source code tree # Checklist <A NAME="checklist"></A> |