Added description of the current HDF5 branches; added a draft of contribution policy. #445
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 6 commits
March 7, 2021 08:59
|
Based on the comments I had on the initial RFC, I reworked completely the policy document. Please let me know if this is the direction we would like to take instead of being too prescriptive. And this is my first "independent" PR. Maybe I screwed things up... Sorry! You can see formatted document in my repo. |
epourmal
changed the title
epourmal
changed the title
added 3 commits
March 8, 2021 22:10
…uctions and left pointers to where to find them, etc.)
Please enter the commit message for your changes. Lines starting
gheber
reviewed
Mar 10, 2021
gheber
reviewed
Mar 10, 2021
gheber
reviewed
Mar 10, 2021
gheber
reviewed
Mar 10, 2021
gheber
reviewed
Mar 10, 2021
gheber
reviewed
Mar 10, 2021
gheber
reviewed
Mar 10, 2021
gheber
reviewed
Mar 10, 2021
gheber
reviewed
Mar 10, 2021
gheber
reviewed
Mar 10, 2021
doc/contributing.md
Outdated
| * Push your changes to GitHub. | ||
| * Issues a pull request and address any code formatting and testing issues reported. | ||
|
|
||
| Once a pull request is correctly formatted and passes GitHub tests, it will be reviewed and evaluated by The HDF Group developers and HDF5 community members who has approval power. |
gheber
reviewed
Mar 10, 2021
doc/contributing.md
Outdated
| * Push your changes to GitHub. | ||
| * Issues a pull request and address any code formatting and testing issues reported. | ||
|
|
||
| Once a pull request is correctly formatted and passes GitHub tests, it will be reviewed and evaluated by The HDF Group developers and HDF5 community members who has approval power. |
There was a problem hiding this comment.
members who can approve pull requests
gheber
reviewed
Mar 10, 2021
doc/contributing.md
Outdated
|
|
||
| # Acceptance criteria for pull request <A NAME="criteria"></A> | ||
|
|
||
| We appreciate every contribution we receive, but we do not accept them all. Those that we *do* accept satisfy the following criteria: |
There was a problem hiding this comment.
... but we may not accept all of them.
gheber
reviewed
Mar 10, 2021
doc/contributing.md
Outdated
|
|
||
| We appreciate every contribution we receive, but we do not accept them all. Those that we *do* accept satisfy the following criteria: | ||
|
|
||
| * **Pull request has a clear purpose** - What does the pull request address? How does it benefit the HDF5 community? |
gheber
reviewed
Mar 10, 2021
doc/contributing.md
Outdated
| We appreciate every contribution we receive, but we do not accept them all. Those that we *do* accept satisfy the following criteria: | ||
|
|
||
| * **Pull request has a clear purpose** - What does the pull request address? How does it benefit the HDF5 community? | ||
| If the pull request does not have a clear purpose and benifits it will not be accepted. |
gheber
reviewed
Mar 10, 2021
doc/contributing.md
Outdated
| * Any file ever created with HDF5 must be readable by any future version of HDF5. | ||
| If the purpose of your patch is to modify HDF5 data model or file format, | ||
| **please** discuss this with us first. File format changes and features required those changes can be introduced only in a new major release. | ||
| * HDF5 has a commitment to remaining *machine-independent*; data created on one platform/environment/architecture **must** remain readable by HDF5 on another. |
gheber
reviewed
Mar 10, 2021
lrknox
reviewed
Mar 10, 2021
doc/contributing.md
Outdated
| * Bug fixes should go to all appropriate branches (develop and maintenance). | ||
| * Build and test your changes. Detailed instructions on how to build and test HDF5 can be found in the `INSTALL*` files in the `release_docs` directory. | ||
| * Push your changes to GitHub. | ||
| * Issues a pull request and address any code formatting and testing issues reported. |
lrknox
reviewed
Mar 10, 2021
doc/contributing.md
Outdated
|
|
||
| * **The pull request is documented** - The HDF5 developers must understand not only *what* a change is doing, but *how* it is doing it. Documenting the code makes it easier for us to understand your patch and will help to maintaine the code in the future. | ||
|
|
||
| * **The pull request passes HDF5 regression testing** - Any issue fixed or functionality added should be accompanied by the corresponding tests and pass HDF5 regression testing run by The HDF Group. We do not expect you to perform comprehensive testing across a multiple platforms before we accept the pull request. If the pull request does not pass regression testing after the merge, The HDF Group developers will work with you on the fixes. |
There was a problem hiding this comment.
testing across multiple platforms (no "a")
lrknox
reviewed
Mar 10, 2021
doc/contributing.md
Outdated
| * **The pull request does not compromise the principles behind HDF5** - HDF5 has a 100% commitment to backward compatibility. | ||
| * Any file ever created with HDF5 must be readable by any future version of HDF5. | ||
| If the purpose of your patch is to modify HDF5 data model or file format, | ||
| **please** discuss this with us first. File format changes and features required those changes can be introduced only in a new major release. |
There was a problem hiding this comment.
suggested: features required {by or for} those changes
lrknox
reviewed
Mar 10, 2021
lrknox
reviewed
Mar 10, 2021
doc/contributing.md
Outdated
| * Documentation | ||
| * [ ] Was the change described in the release_docs/RELEASE.txt file? | ||
| * [ ] Was MANIFEST updated if new files had been added to the source? | ||
| * [ ] Was new function documented in the corresponding public header file using Doxygen? <<TODO: link to Doxygen instructions>> |
lrknox
reviewed
Mar 10, 2021
doc/contributing.md
Outdated
| * Testing | ||
| * [ ] Does the pull request have tests? | ||
| * [ ] If a new feature is added, does it affect HDF5 library perfromance? | ||
| * [ ] Does new feature introduce backward or forward incompatibility? <<TODO: link to the document>> |
There was a problem hiding this comment.
maybe include, provide, or address instead of introduce
There was a problem hiding this comment.
Reworked the line and moved it to coding section. We do have info on Macros, but not on format versioning. I need to get things together and post them.
byrnHDF
reviewed
Mar 10, 2021
doc/branches-explained.md
Outdated
|
|
||
| This document describes current HDF5 branches. | ||
|
|
||
| Branches are tested nightly and testing results are available at https://cdash-internal.hdfgroup.org/ and https://cdash.hdfgroup.org/. Commits that break daily testing should be fixed by 3:00 pm Central time or reverted. We encourage code contributors to check the status of their commits. If you have any questions, please contact testing@hdfgroup.org. |
There was a problem hiding this comment.
We may need an explanation that the CDash results may include known issues with certain platforms and configurations.
Then we need to document the platforms (with CDash identifiers) we test on, description of configurations, known issues, etc. in a separate file.
There was a problem hiding this comment.
We better fix the issue ;-). I think it is a bad idea have tests that are failing and we keep running them. Can we address the failures?
byrnHDF
reviewed
Mar 10, 2021
doc/branches-explained.md
Outdated
| When the feature is complete, the branch is merged back into develop, as well as into any support branches in which the change will be included, and then the feature branch is removed. | ||
|
|
||
| ## `release/*` | ||
| Release branches are used to prepare a new production release. They are primarily used to allow for last minute dotting of is and crossing of ts |
There was a problem hiding this comment.
last minute dotting of is and crossing of ts
S.B.
last minute dotting of i's and crossing of t's
lrknox
approved these changes
Mar 19, 2021
This was referenced Apr 1, 2021
lrknox
added a commit
that referenced
this pull request
Apr 1, 2021
* Snapshot version 1.12 release 1-3. Update version to 1.12.1-4. * First cut of the H5 public API documentation. (#80) * First cut of the H5 public API documentation. * Added H5Z "bonus track." * Applied Quincey's patch. * Added the missing patches from Quincey's original patch. * H5PL (complete) and basic H5VL API documentation. * Added H5I API docs. * Added H5L API docs. * First installment from Elena's H5T batch. * Second installment of Elena's H5T batch. * Final installment of Elena's H5T batch. * Full set of current H5F documentation. (#105) * First cut of the H5 public API documentation. * Added H5Z "bonus track." * Applied Quincey's patch. * Added the missing patches from Quincey's original patch. * H5PL (complete) and basic H5VL API documentation. * Added H5I API docs. * Added H5L API docs. * First installment from Elena's H5T batch. * Second installment of Elena's H5T batch. * Final installment of Elena's H5T batch. * Migrated documentation for SWMR functions. * Catching up on MDC functions. * Integrated the H5F MDC function documentation. * Added MDC and parallel H5F functions. * Slightly updated main page. * Added doxygen/dox/H5AC_cache_config_t.dox to MANIFEST. * Doxygen - added (mostly) beginner functions (#112) * Doxygen - added (mostly) beginner functions * Removed duplicate H5Pset_szip function * Add src/H5module.h to MANIFEST. * close #195. (#196) * Update HDF5PluginMacros.cmake * Update HDF5PluginMacros.cmake * Avoid aligned access for references by decoding into temporary buffer and then copying the result into the actual buffer. Update test to be more thorough with using compound datatype fields everywhere. (#206) * Modify temporary rpath for testing in java example scripts. (#230) * Fix undefined left shifting of negative numbers (#338) Undefined Bahavior Sanitizer errored here about left shifting negative numbers. * Fixes various warnings noticed on Windows (#425) * Fixes various warnings noticed on Windows - Adds a prototype for our implementation of vasprintf - Return type of H5_get_utf16_str() is now non-const - Fixes possible uninitialized return type in Wremove_utf8 - Better isolation of fork() code in accum.c:test_swmr_write_big() - Better isolation of non-zlib code in dsets.c:test_filter_delete() - Removed unused variable in trefer.c:test_reference_cmpnd_obj() * Fixes clang-format issues * Applied clang-tidy readability-non-const-parameter warning fixes auto… (#429) * Automatically applied clang-tidy readability-avoid-const-params-in-decls fixes Removes useless const declarations. * Fixed most readability-non-const-parameter warnings These changes were made automatically by clang-tidy, but I manually reverted the changes related to the H5Z_func_t signature. * Reformat source with clang v10.0.1. Co-authored-by: Larry Knox <lrknox@hdfgroup.org> * Added C++11 override keyword where appropriate (#433) Added H5_OVERRIDE macro for compatibility with both C++11 and older. * Various clang tidy warning fixes (#448) * Fixed clang-tidy bugprone-reserved-identifier warnings * Fixed clang-tidy bugprone-assert-side-effect warnings * Fixed clang-tidy bugprone-copy-constructor-init warning * Fixed clang-tidy readability-redundant-preprocessor warning For error_test.c the removed code was already dead, because it was in the else of an `#if H5_USE_16_API` block. Based on H5Location.h, I think p_get_ref_obj_type was meant to be in `#ifndef DOXYGEN_SHOULD_SKIP_THIS` and an `#endif` was missing. Similarly, in the header, getObjTypeByIdx is only in H5_NO_DEPRECATED_SYMBOLS, not DOXYGEN_SHOULD_SKIP_THIS. * Fixed clang-tidy readability-redundant-string-init warnings * Fixed some clang-tidy performance-type-promotion-in-math-fn warnings * Fixed clang-tidy performance-unnecessary-value-param warnings * Reformat source with clang v10.0.1. Co-authored-by: Larry Knox <lrknox@hdfgroup.org> * Removed checks/workarounds for pre-C++89 compatibility (#449) After 30+ years, just assume that the following exist: - extension-less includes - namespaces - std:: - static_cast - bool * Fixed all clang-tidy bugprone-suspicious-string-compare warnings (#451) * Fixed all clang-tidy bugprone-suspicious-string-compare warnings This change was generated entirely by clang-tidy itself. * Reformat code with clang v10.0.1. Co-authored-by: Larry Knox <lrknox@hdfgroup.org> * Remove 2 functions incorrectly merged from develop in a cherry-pick merge of PR #451. * Purge the buffer used in type conversion. (#263) Some of the uniniitialized bits in the buffer may get carried through all the way to disk, creating a risk for leaks. We observed an msan error during the floating point output conversion. Due to the encoding certain bits could remain untouched during the conversion. In this draft we zero initialize the dbuf used by every convertor. * Fixed HDFFV-10480 (CVE-2018-11206) and HDFFV-11159 (CVE-2018-14033) (#405) * Fixed HDFFV-10480 (CVE-2018-11206) and HDFFV-11159 (CVE-2018-14033) Description Checked against buffer size to prevent segfault, in case of data corruption. + HDFFV-11159 CVE-2018-14033 Buffer over-read in H5O_layout_decode + HDFFV-10480 CVE-2018-11206 Buffer over-read in H5O_fill_new[/old]_decode Platforms tested: Linux/64 (jelly) * Accidentally left in another occurrence of the previous patch from user after a more correct fix was applied, that is the check now accounted for the previous advance of the buffer pointer. Removed it. * Typo * Fixed format issues. * Added test. * Changed arguments to ADD_H5_TEST * Fixing arguments to ADD_H5_TEST again. * Fixing arguments again. * Took out the CMake changes until Allen can help. * Added files: tCVE_2018_11206_fill_old.h5 tCVE_2018_11206_fill_new.h5 * Revert "Took out the CMake changes until Allen can help." This reverts commit c21324d. * Revert "Fixing arguments again." This reverts commit 5832a70. * Revert "Fixing arguments to ADD_H5_TEST again." This reverts commit b45de82. * Revert "Changed arguments to ADD_H5_TEST" This reverts commit 1671982. * Added first argument to ADD_H5_TEST for HDFFV-10480 fix. * Changed argument 0 to 1 * Revert "Changed argument 0 to 1" This reverts commit b343d66. * Revert "Added first argument to ADD_H5_TEST for HDFFV-10480 fix." This reverts commit b8a0f9a. * Added first argument and corrected the second. * Updated fixes for HDFFV-10480 and HDFFV-11159/HDFFV-11049 * Improved error messages. * Added description of the current HDF5 branches; added a draft of contribution policy. (#445) * Added description of the current HDF5 branches. * Removed capitalization in from Develop, Release, Feature to reflect the real naming schema * Added a draft of contributions guidance document. * Fixed typos. * Fixed section title. * Fixed typo. * Fixed typos and formatting. * Fixed many typos and simplified the text (e.g., removed testing instructions and left pointers to where to find them, etc.) * Fixed a typo. Please enter the commit message for your changes. Lines starting * Added contributing.md file and rearranged doc entries in alphabetical order. * ddressed Gerd's review comments; found and fixed more typos. * Addressed comments from Larry and Scot. * Fix CMake error message location. (#478) Print error message if Perl is not found. * Committing clang-format changes Co-authored-by: Gerd Heber <gheber@hdfgroup.org> Co-authored-by: bljhdf <58825073+bljhdf@users.noreply.github.com> Co-authored-by: H. Joe Lee <hyoklee@hdfgroup.org> Co-authored-by: Quincey Koziol <quincey@koziol.cc> Co-authored-by: Sean McBride <sean@rogue-research.com> Co-authored-by: Dana Robinson <43805+derobins@users.noreply.github.com> Co-authored-by: Yu Feng <rainwoodman@gmail.com> Co-authored-by: bmribler <39579120+bmribler@users.noreply.github.com> Co-authored-by: epourmal <epourmal@hdfgroup.org> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
lrknox
added a commit
that referenced
this pull request
Apr 2, 2021
* close #195. (#196) * Update HDF5PluginMacros.cmake * Update HDF5PluginMacros.cmake * Modify temporary rpath for testing in java example scripts. (#230) * Fix undefined left shifting of negative numbers (#338) Undefined Bahavior Sanitizer errored here about left shifting negative numbers. * Update license url (#332) * Modify temporary rpath for testing in java example scripts. * Update URL in source file Copyright headers for web copy of COPYING file - src and test directories. * Cleans up a couple of MSVC warnings in testhdf5 (#475) * Fixes a few testhdf5 warnings raised in Visual Studio Visual Studio is grumpier about treating pointers like integers than gcc. * Committing clang-format changes Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * Fix typos and grammar errors. (#476) * Suppresses the tcheck_version test's abort dialog on Windows (#477) * Suppresses the tcheck_version test's abort dialog on Windows Windows raises a modal abort/retry/ignore dialog box when CRT calls abort(). This change installs a report hook that suppresses the dialog so that the CMake tests don't time out waiting for a nonexistent user to click a dialog box. * Committing clang-format changes * Removes __cdecl from callback Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * Purge the buffer used in type conversion. (#263) Some of the uniniitialized bits in the buffer may get carried through all the way to disk, creating a risk for leaks. We observed an msan error during the floating point output conversion. Due to the encoding certain bits could remain untouched during the conversion. In this draft we zero initialize the dbuf used by every convertor. * Fixed HDFFV-10480 (CVE-2018-11206) and HDFFV-11159 (CVE-2018-14033) (#405) * Fixed HDFFV-10480 (CVE-2018-11206) and HDFFV-11159 (CVE-2018-14033) Description Checked against buffer size to prevent segfault, in case of data corruption. + HDFFV-11159 CVE-2018-14033 Buffer over-read in H5O_layout_decode + HDFFV-10480 CVE-2018-11206 Buffer over-read in H5O_fill_new[/old]_decode Platforms tested: Linux/64 (jelly) * Accidentally left in another occurrence of the previous patch from user after a more correct fix was applied, that is the check now accounted for the previous advance of the buffer pointer. Removed it. * Typo * Fixed format issues. * Added test. * Changed arguments to ADD_H5_TEST * Fixing arguments to ADD_H5_TEST again. * Fixing arguments again. * Took out the CMake changes until Allen can help. * Added files: tCVE_2018_11206_fill_old.h5 tCVE_2018_11206_fill_new.h5 * Revert "Took out the CMake changes until Allen can help." This reverts commit c21324d. * Revert "Fixing arguments again." This reverts commit 5832a70. * Revert "Fixing arguments to ADD_H5_TEST again." This reverts commit b45de82. * Revert "Changed arguments to ADD_H5_TEST" This reverts commit 1671982. * Added first argument to ADD_H5_TEST for HDFFV-10480 fix. * Changed argument 0 to 1 * Revert "Changed argument 0 to 1" This reverts commit b343d66. * Revert "Added first argument to ADD_H5_TEST for HDFFV-10480 fix." This reverts commit b8a0f9a. * Added first argument and corrected the second. * Updated fixes for HDFFV-10480 and HDFFV-11159/HDFFV-11049 * Improved error messages. * Added description of the current HDF5 branches; added a draft of contribution policy. (#445) * Added description of the current HDF5 branches. * Removed capitalization in from Develop, Release, Feature to reflect the real naming schema * Added a draft of contributions guidance document. * Fixed typos. * Fixed section title. * Fixed typo. * Fixed typos and formatting. * Fixed many typos and simplified the text (e.g., removed testing instructions and left pointers to where to find them, etc.) * Fixed a typo. Please enter the commit message for your changes. Lines starting * Added contributing.md file and rearranged doc entries in alphabetical order. * ddressed Gerd's review comments; found and fixed more typos. * Addressed comments from Larry and Scot. * Fix CMake error message location. (#478) Print error message if Perl is not found. * Committing clang-format changes * Update MANIFEST. Co-authored-by: H. Joe Lee <hyoklee@hdfgroup.org> Co-authored-by: Sean McBride <sean@rogue-research.com> Co-authored-by: Dana Robinson <43805+derobins@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Yu Feng <rainwoodman@gmail.com> Co-authored-by: bmribler <39579120+bmribler@users.noreply.github.com> Co-authored-by: epourmal <epourmal@hdfgroup.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a file with description of the current HDF5 branches.