-
Notifications
You must be signed in to change notification settings - Fork 103
add-contributing-doc #521
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add-contributing-doc #521
Changes from 1 commit
3881812
c4a7bd3
d4633f1
ea2e3d2
bbc83d3
b0b9e9d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Contributing to iceberg-cpp | ||
|
|
||
| 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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Developers must use C++23-compatible compiler.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
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 | ||
There was a problem hiding this comment.
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.