Skip to content
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributing to iceberg-cpp
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I have commented for multiple times that I'm against adding this file.


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. [][]

## Development environment

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. [][][]

### Local prerequisites

- Git
- CMake and a C++17-compatible compiler
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Developers must use C++23-compatible compiler.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Developers must use C++23-compatible compiler.

Updated the prerequisite to C++23-compatible compiler in CONTRIBUTING.md and pushed the change. Thanks for pointing this out!

- Python (for pre-commit)
- Docker (recommended for a consistent dev environment) [][]

## Building and testing

Typical steps (refer to README for exact commands and options): [][]

```bash
mkdir build
cd build
cmake ..
make -j$(nproc)
ctest
Loading