Skip to content

Commit 3881812

Browse files
committed
Add CONTRIBUTING guide for developers
1 parent 75204b1 commit 3881812

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing to iceberg-cpp
2+
3+
This document describes how to set up a development environment, run tests, and use existing tooling such as Docker and pre-commit for iceberg-cpp. [][]
4+
5+
## Development environment
6+
7+
The project can be built and developed using the existing Docker-based environment. Please refer to the README and Doxygen documentation for more detailed API and usage information. [][][]
8+
9+
### Local prerequisites
10+
11+
- Git
12+
- CMake and a C++17-compatible compiler
13+
- Python (for pre-commit)
14+
- Docker (recommended for a consistent dev environment) [][]
15+
16+
## Building and testing
17+
18+
Typical steps (refer to README for exact commands and options): [][]
19+
20+
```bash
21+
mkdir build
22+
cd build
23+
cmake ..
24+
make -j$(nproc)
25+
ctest

0 commit comments

Comments
 (0)