diff options
| author | Stefan Boberg <[email protected]> | 2025-11-07 14:49:13 +0100 |
|---|---|---|
| committer | GitHub Enterprise <[email protected]> | 2025-11-07 14:49:13 +0100 |
| commit | 24e43a913f29ac3b314354e8ce5175f135bcc64f (patch) | |
| tree | ca442937ceeb63461012b33a4576e9835099f106 /thirdparty/blake3/CONTRIBUTING.md | |
| parent | get oplog attachments (#622) (diff) | |
| download | zen-24e43a913f29ac3b314354e8ce5175f135bcc64f.tar.xz zen-24e43a913f29ac3b314354e8ce5175f135bcc64f.zip | |
switch to xmake for package management (#611)
This change removes our dependency on vcpkg for package management, in favour of bringing some code in-tree in the `thirdparty` folder as well as using the xmake build-in package management feature. For the latter, all the package definitions are maintained in the zen repo itself, in the `repo` folder.
It should now also be easier to build the project as it will no longer depend on having the right version of vcpkg installed, which has been a common problem for new people coming in to the codebase. Now you should only need xmake to build.
* Bumps xmake requirement on github runners to 2.9.9 to resolve an issue where xmake on Windows invokes cmake with `v144` toolchain which does not exist
* BLAKE3 is now in-tree at `thirdparty/blake3`
* cpr is now in-tree at `thirdparty/cpr`
* cxxopts is now in-tree at `thirdparty/cxxopts`
* fmt is now in-tree at `thirdparty/fmt`
* robin-map is now in-tree at `thirdparty/robin-map`
* ryml is now in-tree at `thirdparty/ryml`
* sol2 is now in-tree at `thirdparty/sol2`
* spdlog is now in-tree at `thirdparty/spdlog`
* utfcpp is now in-tree at `thirdparty/utfcpp`
* xmake package repo definitions is in `repo`
* implemented support for sanitizers. ASAN is supported on windows, TSAN, UBSAN, MSAN etc are supported on Linux/MacOS though I have not yet tested it extensively on MacOS
* the zencore encryption implementation also now supports using mbedTLS which is used on MacOS, though for now we still use openssl on Linux
* crashpad
* bumps libcurl to 8.11.0 (from 8.8.0) which should address a rare build upload bug
Diffstat (limited to 'thirdparty/blake3/CONTRIBUTING.md')
| -rw-r--r-- | thirdparty/blake3/CONTRIBUTING.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/thirdparty/blake3/CONTRIBUTING.md b/thirdparty/blake3/CONTRIBUTING.md new file mode 100644 index 000000000..3a605f255 --- /dev/null +++ b/thirdparty/blake3/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +We welcome and encourage third-party contributions to BLAKE3, be it reports of issues encountered while using the software or proposals of patches. + +## Bug reports + +Bugs and other problems should be reported on [GitHub Issues](https://github.com/BLAKE3/BLAKE3/issues). + +If you report a bug, please: + +* Check that it's not already reported in the [GitHub Issues](https://github.com/BLAKE3/BLAKE3/issues). +* Provide information to help us diagnose and ideally reproduce the bug. + +## Patches + +We encourage you to fix a bug via a [GitHub Pull request](https://github.com/BLAKE3/BLAKE3/pulls), preferably after creating a related issue and referring it in the PR. + +If you contribute code and submit a patch, please note the following: + +* We use Rust's stable branch for developing BLAKE3. +* Pull requests should target the `master` branch. +* Try to follow the established Rust [style guidelines](https://doc.rust-lang.org/1.0.0/style/). + +Also please make sure to create new unit tests covering your code additions. You can execute the tests by running: + +```bash +cargo test +``` + +All third-party contributions will be recognized in the list of contributors. + |