Skip to content
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

Remove .clang-format style and update docs [skip ci] #1587

Merged
merged 3 commits into from
Nov 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
31 changes: 26 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,16 +323,37 @@ Remember, if you are unsure about anything, don't hesitate to comment on issues
and ask for clarifications!

### Code Formatting
RAPIDS Accelerator for Apache Spark follows the same coding style guidelines as the Apache Spark
project. For IntelliJ IDEA users, an
[example code style settings file](docs/dev/idea-code-style-settings.xml) is available in the
`docs/dev/` directory.

#### Java

This project follows the
This Java code in this project (`src/main/java`) follows the
[Oracle Java code conventions](http://www.oracle.com/technetwork/java/codeconvtoc-136057.html).


#### C++

The C++ code in this project (`src/main/cpp`) follows the
[coding style from `rapidsai/cudf` repository](https://github.com/rapidsai/cudf/blob/main/cpp/doxygen/developer_guide/DEVELOPER_GUIDE.md#code-and-documentation-style-and-formatting).

We also provide a precommit-hook to format code using cudf's C++ `clang-format` style.
To use precommit-hook, install it on your system such as using `conda` or `pip`:
```
conda install -c conda-forge pre-commit
```
```
pip install pre-commit
```

Then, run pre-commit hooks before committing your code. This wil reformat the stagged files:
```
pre-commit run
```

And for reformatting all files:
```
pre-commit run --all-files
```

### Sign your work

We require that all contributors sign-off on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
Expand Down
204 changes: 0 additions & 204 deletions src/main/cpp/.clang-format

This file was deleted.