Skip to content

Commit 1a8695e

Browse files
committed
Update formatting related documentation
Specifically, clang-format was dropped from the Java API documentation and pre-commit in now mentioned in the contributing documentation.
1 parent 9d69352 commit 1a8695e

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,12 @@ Thanks for your interest in TileDB-VCF. The notes below give some pointers for f
1818
- Make changes locally, then rebuild as appropriate for the level of changes (e.g.: `make` for `libtilebvcf` or `python setup.py develop` for `apis/python`).
1919
- Make sure to run `make check`, or `pytest` to verify changes against tests (add new tests where applicable).
2020
- Please submit [pull requests](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request) against the default [`main` branch of TileDB-VCF](https://github.com/TileDB-Inc/TileDB-VCF/tree/main).
21+
- If you edit the Python files, please run the pre-commit hooks
22+
23+
```sh
24+
python -m venv ./pre-commit
25+
source ./pre-commit/bin/activate
26+
python -m pip -v install pre-commit
27+
pre-commit run -a -v
28+
deactivate
29+
```

apis/java/src/main/java/io/tiledb/libvcfnative/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@ To build the binding you must first compile the java file to a header file by us
55
javac -cp .:commons-io-2.14.0.jar *.java -h .;
66
```
77

8-
Next, format the header and replace the old
8+
Next, replace the old header
99
```
10-
clang-format -i io_tiledb_libvcfnative_LibVCFNative.h;
1110
mv io_tiledb_libvcfnative_LibVCFNative.h LibVCFNative.h;
1211
```
1312

1413
Finally, remove all ```.class``` files
1514

1615
```
1716
rm *.class;
18-
```
17+
```
18+
19+
This process can be done autmatically using the `genearteJNI.sh` script.

0 commit comments

Comments
 (0)