Skip to content

Commit

Permalink
Add CONTRIBUTORS.md (#86)
Browse files Browse the repository at this point in the history
  • Loading branch information
hajimes authored Sep 17, 2024
1 parent 962ce52 commit 0917f27
Show file tree
Hide file tree
Showing 4 changed files with 116 additions and 40 deletions.
76 changes: 41 additions & 35 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Changelog

All notable changes to this project will be documented here.
All notable changes to this project will be documented here. For a list of
contributors, see the
[Contributors](https://mmh3.readthedocs.io/en/latest/CONTRIBUTORS.html) page.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
The format is based on
[Keep a Changelog 1.1.0](https://keepachangelog.com/en/1.1.0/).
This project has adhered to
[Semantic Versioning](https://semver.org/spec/v2.0.0.html) since version 3.0.0.
[Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html)
since version 3.0.0.

## [Unreleased]

Expand All @@ -16,7 +20,8 @@ This project has adhered to
([#75](https://github.com/hajimes/mmh3/pull/75)).
These functions are implemented with
[METH_FASTCALL](https://docs.python.org/3/c-api/structures.html#c.METH_FASTCALL),
offering improved performance over legacy functions.
offering improved performance over legacy functions
([#84](https://github.com/hajimes/mmh3/pull/84)).
- Slightly improve the performance of the `hash_bytes()` function.
- Add Read the Docs documentation
([#54](https://github.com/hajimes/mmh3/issues/54)).
Expand All @@ -27,26 +32,29 @@ This project has adhered to

- **Backward-incompatible**: The `seed` argument is now strictly validated to
ensure it falls within the range [0, 0xFFFFFFFF]. A `ValueError` is raised
if the seed is out of range.
if the seed is out of range ([#84](https://github.com/hajimes/mmh3/pull/84)).
- **Backward-incompatible**: Change the constructors of hasher classes to
accept a buffer as the first argument
([#83](https://github.com/hajimes/mmh3/pull/83)).
- The type of flag argumens has been changed from `bool` to `Any`.
- The type of flag argumens has been changed from `bool` to `Any`
([#84](https://github.com/hajimes/mmh3/pull/84)).
- Change the format of CHANGELOG.md to conform to the
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) standard
([#63](https://github.com/hajimes/mmh3/pull/63)).

### Deprecated

- Deprecate the `hash_from_buffer()` function.
Use `mmh3_32_sintdigest()` or `mmh3_32_uintdigest()` as alternatives.
Use `mmh3_32_sintdigest()` or `mmh3_32_uintdigest()` as alternatives
([#84](https://github.com/hajimes/mmh3/pull/84)).

### Fixed

- Fix a reference leak in the `hash_from_buffer()` function
([#75](https://github.com/hajimes/mmh3/pull/75)).
- Fix type hints ([#76](https://github.com/hajimes/mmh3/pull/76),
[#77](https://github.com/hajimes/mmh3/pull/77)).
[#77](https://github.com/hajimes/mmh3/pull/77),
[#84](https://github.com/hajimes/mmh3/pull/84)).

## [4.1.0] - 2024-01-09

Expand Down Expand Up @@ -93,29 +101,28 @@ This project has adhered to

### Removed

- **Backward-incompatible**: A hash function now returns the same value under
big-endian platforms as that under little-endian ones
([#47](https://github.com/hajimes/mmh3/issues/47)).
- **Backward-incompatible**: Remove the `__version__` constant from the module
([#42](https://github.com/hajimes/mmh3/issues/42)). Use `importlib.metadata`
instead.
- Drop support for Python 3.7, as it will reach the end of life on 2023-06-27.
- Backward incompatible changes:
- A hash function now returns the same value under big-endian platforms as
that under little-endian ones
([#47](https://github.com/hajimes/mmh3/issues/47)).
- Remove the `__version__` constant from the module
([#42](https://github.com/hajimes/mmh3/issues/42)). Use `importlib.metadata`
instead.

## [3.1.0] - 2023-03-24

### Added

- Add support for Python 3.10 and 3.11. Thanks
[wouter bolsterlee](https://github.com/wbolster) and
[Dušan Nikolić](https://github.com/n-dusan)!
- Add support for Python 3.10 and 3.11
([#35](https://github.com/hajimes/mmh3/pull/35),
[#37](https://github.com/hajimes/mmh3/pull/37)).
- Add support for 32-bit architectures such as `i686` and `armv7l`. From now on,
`hash()` and `hash_from_buffer()` on these architectures will generate the
same hash values as those on other environments. Thanks
[Danil Shein](https://github.com/dshein-alt)!
same hash values as those on other environments
([#40](https://github.com/hajimes/mmh3/pull/40)).
- In relation to the above, `manylinux2014_i686` wheels are now available.
- Support for hashing huge data (>16GB). Thanks
[arieleizenberg](https://github.com/arieleizenberg)!
- Support for hashing huge data (>16GB)
([#34](https://github.com/hajimes/mmh3/pull/34)).

### Removed

Expand All @@ -131,8 +138,8 @@ This project has adhered to
- Supported platforms are `manylinux1_x86_64`, `manylinux2010_x86_64`,
`manylinux2014_aarch64`, `win32`, `win_amd64`, `macosx_10_9_x86_64`, and
`macosx_11_0_arm64` (Apple Silicon).
- Add support for newer macOS environments. Thanks
[Matthew Honnibal](https://github.com/honnibal)!
- Add support for newer macOS environments
([#22](https://github.com/hajimes/mmh3/pull/22)).
- Add support for Python 3.7, 3.8, and 3.9.

### Changed
Expand All @@ -147,21 +154,21 @@ This project has adhered to

### Fixed

- Bugfix for `hash_bytes()`. Thanks [doozr](https://github.com/doozr)!
- Bugfix for `hash_bytes()` ([#15](https://github.com/hajimes/mmh3/pull/15)).

## [2.5] - 2017-10-28

### Added

- Add `hash_from_buffer()`. Thanks [Dimitri Vorona](https://github.com/alendit)!
- Add `hash_from_buffer()` ([#13](https://github.com/hajimes/mmh3/pull/13)).
- Add a keyword argument `signed`.

## [2.4] - 2017-05-27

### Added

- Support seeds with 32-bit unsigned integers; thanks
[Alexander Maznev](https://github.com/pik)!
- Support seeds with 32-bit unsigned integers
([#6](https://github.com/hajimes/mmh3/pull/6)).
- Support 64-bit data (under 64-bit environments)
- Add unit testing and continuous integration with Travis CI and AppVeyor.

Expand All @@ -183,16 +190,15 @@ This project has adhered to

## [2.3] - 2013-12-08

The first two commits are from [Derek Wilson](https://github.com/underrun).
Thanks!

### Added

- Add `hash128()`, which returns a 128-bit signed integer.
- Add `hash128()`, which returns a 128-bit signed integer
([#3](https://github.com/hajimes/mmh3/pull/3)).

### Fixed

- Fix a misplaced operator which could cause memory leak in a rare condition.
- Fix a misplaced operator which could cause memory leak in a rare condition
([#2](https://github.com/hajimes/mmh3/pull/2)).
- Fix a malformed value to a Python/C API function which may cause runtime
errors in recent Python 3.x versions.

Expand All @@ -201,8 +207,8 @@ Thanks!
### Added

- Improve portability to support systems with old gcc (version < 4.4) such as
CentOS/RHEL 5.x. (Commit from
[Micha Gorelick](https://github.com/mynameisfiber). Thanks!)
CentOS/RHEL 5.x
([#1](https://github.com/hajimes/mmh3/pull/1)).

## [2.1] - 2013-02-25

Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,8 @@ complete changelog.
([#75](https://github.com/hajimes/mmh3/pull/75)).
These functions are implemented with
[METH_FASTCALL](https://docs.python.org/3/c-api/structures.html#c.METH_FASTCALL),
offering improved performance over legacy functions.
offering improved performance over legacy functions
([#84](https://github.com/hajimes/mmh3/pull/84)).
- Slightly improve the performance of the `hash_bytes()` function.
- Add Read the Docs documentation
([#54](https://github.com/hajimes/mmh3/issues/54)).
Expand All @@ -152,26 +153,29 @@ complete changelog.

- **Backward-incompatible**: The `seed` argument is now strictly validated to
ensure it falls within the range [0, 0xFFFFFFFF]. A `ValueError` is raised
if the seed is out of range.
if the seed is out of range ([#84](https://github.com/hajimes/mmh3/pull/84)).
- **Backward-incompatible**: Change the constructors of hasher classes to
accept a buffer as the first argument
([#83](https://github.com/hajimes/mmh3/pull/83)).
- The type of flag argumens has been changed from `bool` to `Any`.
- The type of flag argumens has been changed from `bool` to `Any`
([#84](https://github.com/hajimes/mmh3/pull/84)).
- Change the format of CHANGELOG.md to conform to the
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) standard
([#63](https://github.com/hajimes/mmh3/pull/63)).

#### Deprecated

- Deprecate the `hash_from_buffer()` function.
Use `mmh3_32_sintdigest()` or `mmh3_32_uintdigest()` as alternatives.
Use `mmh3_32_sintdigest()` or `mmh3_32_uintdigest()` as alternatives
([#84](https://github.com/hajimes/mmh3/pull/84)).

#### Fixed

- Fix a reference leak in the `hash_from_buffer()` function
([#75](https://github.com/hajimes/mmh3/pull/75)).
- Fix type hints ([#76](https://github.com/hajimes/mmh3/pull/76),
[#77](https://github.com/hajimes/mmh3/pull/77)).
[#77](https://github.com/hajimes/mmh3/pull/77),
[#84](https://github.com/hajimes/mmh3/pull/84)).

### [4.1.0] - 2024-01-09

Expand Down
65 changes: 65 additions & 0 deletions docs/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Contributors

This page acknowledges contributors to the project. For details on the
project's history and changes, please refer to the
[Changelog](./changelog.md)
page. If you're interested in contributing, be sure to review the
[Contributing](./CONTRIBUTING.md) guide.

## Code Contributors

We gratefully acknowledge the contributions of the following individuals:

- [Alexander Maznev](https://github.com/pik),
[#6](https://github.com/hajimes/mmh3/pull/6).
- [@arieleizenberg](https://github.com/arieleizenberg),
[#34](https://github.com/hajimes/mmh3/pull/34).
- [Micha Gorelick](https://github.com/mynameisfiber),
[#1](https://github.com/hajimes/mmh3/pull/1).
- [Danil Shein](https://github.com/dshein-alt),
[#40](https://github.com/hajimes/mmh3/pull/40).
- [Derek Wilson](https://github.com/underrun),
[#2](https://github.com/hajimes/mmh3/pull/2),
[#3](https://github.com/hajimes/mmh3/pull/3).
- [Dimitri Vorona](https://github.com/alendit),
[#13](https://github.com/hajimes/mmh3/pull/13).
- [@doozr](https://github.com/doozr),
[#15](https://github.com/hajimes/mmh3/pull/15).
- [Dušan Nikolić](https://github.com/n-dusan),
[#37](https://github.com/hajimes/mmh3/pull/37).
- [Matthew Honnibal](https://github.com/honnibal),
[#22](https://github.com/hajimes/mmh3/pull/22).
- [wouter bolsterlee](https://github.com/wbolster),
[#35](https://github.com/hajimes/mmh3/pull/35).

## Community Contributors

We would also like to thank the following contributors for their valuable
bug reports, feature suggestions, and other contributions:

- [Antoine Pitrou](https://github.com/pitrou),
[#10](https://github.com/hajimes/mmh3/issues/10).
- [Benjamin Bengfort](https://github.com/bbengfort),
[#46](https://github.com/hajimes/mmh3/issues/46).
- [Christian von Schultz](https://github.com/vonschultz),
[#50](https://github.com/hajimes/mmh3/issues/50).
- [Dan Blanchard](https://github.com/dan-blanchard),
[#8](https://github.com/hajimes/mmh3/issues/8).
- [Heather Lapointe](https://github.com/Alphadelta14),
[#25](https://github.com/hajimes/mmh3/issues/25).
- [Jacques Dark](https://github.com/jqdark),
[#12](https://github.com/hajimes/mmh3/issues/12).
- [Niklas Semmler](https://github.com/niklassemmler),
[#7](https://github.com/hajimes/mmh3/issues/7).
- [Ryan](https://github.com/ryanfwy),
[#25](https://github.com/hajimes/mmh3/issues/25).
- [Sebastian Kreft](https://github.com/sk-),
[#17](https://github.com/hajimes/mmh3/issues/17).
- [Tom Mitchell](https://github.com/tcmitchell),
[#51](https://github.com/hajimes/mmh3/issues/51).
- [Varunkumar Nagarajan](https://github.com/varunkumar),
[#39](https://github.com/hajimes/mmh3/issues/39).
- [@xqdd](https://github.com/xqdd),
[#9](https://github.com/hajimes/mmh3/issues/9).
- [@yzssbo](https://github.com/yzssbo),
[#25](https://github.com/hajimes/mmh3/issues/25).
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ mmh3 is a Python extension for `MurmurHash (MurmurHash3) <https://en.wikipedia.o
Quickstart<quickstart>
api
Changelog<changelog>
CONTRIBUTORS

.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit 0917f27

Please sign in to comment.