1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
# Contributing to ZXC
Thank you for your interest in contributing to ZXC! This guide will help you get started.
## Developer Certificate of Origin (DCO)
By contributing, you certify that:
- You have the right to submit the contribution
- You agree to license your contribution under the BSD-3-Clause license
Add this to your commits:
```bash
git commit -s -m "Your commit message"
```
## License Headers
To maintain legal clarity and recognize all contributors, every new source file (.c, .h, .rs, .py, etc.) must include the following header at the very top:
```C
/*
* ZXC - High-performance lossless compression
*
* Copyright (c) 2025-2026 Bertrand Lebonnois and contributors.
* SPDX-License-Identifier: BSD-3-Clause
*/
```
## Quick Start
### Build and Test
```bash
git clone https://github.com/hellobertrand/zxc.git
cd zxc
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug
make -j
ctest --output-on-failure
```
### Format Code
```bash
clang-format -i src/lib/*.c include/*.h
```
## Requirements
- **C17** compiler (GCC, Clang, or MSVC)
- **CMake** 3.10+
- Follow `.clang-format` style (Google)
- All code must be ASCII-only
- Pass `ctest` and static analysis
## Submitting Changes
1. Fork and create a feature branch
2. Add tests for new functionality
3. Ensure CI passes (build, tests, benchmarks)
4. Sign your commits with `-s`
5. Open a PR to `main`
## Reporting Issues
Include:
- ZXC version (`zxc --version`)
- OS and architecture
- Minimal reproduction steps
Thank you for making ZXC better!
|
