Skip to content

Commit 077d843

Browse files
authored
Add note in the README "Pull request Review and Merge"
1 parent 8f9746d commit 077d843

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,21 @@ c2ffi $(pkg-config --cflags-only-I hdf5 | ruby -npe '$_.strip!.gsub!(/-I/, "")<<
2222
c2ffi4rb hdf5.json > lib/hdf5/ffi.rb
2323
```
2424

25-
The auto-generated bindings require some minor manual modifications, see the end of the ffi3.rb file.
25+
The auto-generated bindings require some minor manual modifications.
2626

27-
### HDF5 1.10 or 1.14
27+
### Pull Request Review and Merge
2828

29-
Compatibility issues between versions of HDF5
29+
The HDF5 Ruby bindings have not been created or maintained for a long time. This means there are very few people in the Ruby community who can create or maintain these bindings. In other words, the history shows that the Ruby community does not have enough time and resources to keep ruby-hdf5 at a high quality.
3030

31-
Several functions in HDF5 are incompatible between 1.10 and 1.14 (the latest version at the time of writing). The current version of ruby-hdf5 is compliant with 1.10. This is because the latest version of the Ubuntu package is 1.10. However, 1.14 is already distributed with homebrew and 1.10 will be removed during 2025. It will need to be rewritten for 1.14 in the near future.
31+
Because of this situation, we have set the review standards for pull requests **very low** in this project. Specifically, we will **always** merge a pull request unless it contains harmful changes. Even if there are small bugs, we will merge it as long as there are no serious issues. This is because the author can send more pull requests to fix the bugs later. If we don’t merge, nothing will move forward. The time and effort to write and test code are very valuable.
32+
33+
In this project, we do not focus on keeping the code perfectly clean and bug-free. This may seem unusual for a library like HDF5, which handles numbers and data. But the common quality-first approach approach only works when there are enough developers and time. We intentionally avoid this in ruby-hdf5.
34+
35+
In ruby-hdf5, we focus more on keeping the project alive than making the code perfect at a certain point. Like how different organisms adapt to different light environments, the development strategy should change based on the community’s situation.
36+
37+
## Acknowledgement
38+
39+
https://github.com/edmundhighcock/hdf5
3240

3341
## License
3442

0 commit comments

Comments
 (0)